华为云 API

在本插件中，我们提供了如下功能:

• 搜索功能，包括 API、SDK、示例、云服务、错误码
• 查看华为云 API 文档、SDK 代码示例，调试 API
• 查看 Codelabs 示例文档及源码
• 下载示例代码文件
• SDK 代码智能自动补全、SDK 自动引入依赖
• SDK 代码通过 Codelens 查看 API 文档、跳转调试 API
• KooCLI 命令自动补全

版本说明

无

版本要求

VSCode Version 1.60+ (including)

安装插件

1.打开 VSCode 并进入扩展商店。

2.在扩展商店中搜索 "Huawei Cloud Toolkit Platform", 查看详情并安装。

3.在扩展商店中搜索 "Huawei Cloud API", 查看详情并安装。

4.重启 VSCode, 左侧边栏中会展示已安装的 Huawei Cloud Toolkit 插件。

操作指南

1. 点击左侧的 Huawei Cloud Toolkit Platform 插件logo，展开插件左侧侧边栏。

2. 点击插件左侧侧边栏Login或Login Overview按钮，右侧会出现登录设置页。 可以输入华为账号、AK/SK 或 CSDN 账号进行登录操作。如果没有 AK/SK，可点击访问密钥前往获取。

3. 如果已有华为云账号，可前往 https://console.huaweicloud.com/iam/?region=cn-north-4#/mine/accessKey 跳转华为云登录页登录，登录后鼠标滑到页面右上角用户名，点击下拉菜单的我的凭证按钮。

4. 跳转我的凭证页，点击左侧访问密钥按钮，跳转新页面。

5. 点击新增访问密钥按钮，进行身份验证，完成后页面出现访问密钥ID，且会下载AK/SK 表格到本地。

6. 打开表格，回到登录设置页，填入表格相关内容，并点击 Login 按钮，出现登录成功弹窗。

7. 如果未注册华为账号，可点击华为云 AK/SK 登录页 注册 按钮，跳到注册页面。

8. 注册完成后，登录账号，进行3-6的操作即可。

9. 登录成功后，左侧侧边栏可浏览 云服务、 API 和 示例，选中您感兴趣的云服务、 API 或示例，右侧页面会展示详细的内容。

10. 也可点击左侧侧边栏华为云 API的API 主页按钮，点击之后右侧页面会展示搜索页，可以搜索云服务、API、SDK、示例、错误码。

11. 也可打开 Java、JavaScript、TypeScript、Go 语言文件，输入 API 名称体验 SDK 代码智能自动补全功能。

12. 也可打开 Java 文件，在 SDK 代码智能自动补全后， 引入相应 SDK 包，体验 SDK 代码 Codelens 跳转功能。

13. 也可打开 .sh 或 .bat 脚本文件，输入 'hcloud ' 体验 KooCLI 命令自动补全功能。

14. 如需更换账号，可以点击Login Overview 或 Logout退出登陆，随后进行2~6的操作即可。

Huawei Cloud APIs

使用到的公网地址

• 华为云 APIExplorer 服务公网接口域名：https://apiexplorer.cn-north-4.myhuaweicloud.com
• 华为云 Nemo 服务公网接口域名: https://nemo.cn-north-4.myhuaweicloud.com
• 华为云 SDK 服务公网接口域名: https://sdkcenter.cn-north-4.myhuaweicloud.com
• 华为云 Error 服务公网接口域名: https://apierrorcenter.cn-north-4.myhuaweicloud.com
• 华为云 CodeLabs 服务公网接口域名: https://codelabs.cn-north-4.myhuaweicloud.com
• 华为云 KooCLI 服务公网接口域名 (Windows 系统): https://cn-north-6-hdn-hwcloudcli.obs.cn-north-6.myhuaweicloud.com
• 华为云 KooCLI 服务公网接口域名 (其他 系统): https://hwcloudcli.obs.cn-north-1.myhwclouds.com
• 华为云 APIExplorer 文档页面地址: https://apiexplorer.developer.huaweicloud.com
• 华为云帮助中心: https://support.huaweicloud.com
• 华为云静态资源库: https://res.hc-cdn.com
• 华为云 OBS 服务公网接口域名: https://obs.cn-north-4.myhuaweicloud.com
• 华为云 IotDA 服务公网接口域名: https://iotps.cn-north-4.myhuaweicloud.com
• 华为云 IAM 服务公网接口域名: https://iam.myhuaweicloud.com

注: 插件当前仅支持华为云中国站配套的云服务，国际站或中国站用户如果购买了配套的中国站云服务，您的数据将储存在中国大陆；具体详见《隐私政策声明》

This extension provides the following functions:

• Search APIs, SDKs, cloud services, and error codes
• View Huawei Cloud API documentation and SDK code samples, and debug APIs
• SDK code auto-completion and dependency import
• View API documentation and debug APIs via Codelens
• KooCLI command auto-completion

Version Description

None

Version Requirements

VSCode Version 1.60+ (including)

Installing the Extension

1. Open VSCode and enter the extension marketplace.

2. Search for Huawei Cloud Toolkit Platform in the extension marketplace, view details, and install the extension.

3. Search for Huawei Cloud APIs in the extension marketplace, view details, and install the extension.

4. Restart VSCode. The Huawei Cloud Toolkit extension is displayed in the left pane.

Operation Guide

1. Click the Huawei Cloud Toolkit Platform extension logo on the left to expand the left pane.

**2.**Click Login or Login Overview on the left of the extension to display the login page. Log in with a HUAWEI ID, AK/SK, or CSDN account. If you do not have an AK/SK, click Access Keys, and create one.

3. If you have a HUAWEI ID, log in via https://console.huaweicloud.com/iam/?region=cn-north-4&locale=en-us#/mine/accessKey . Hover over your username in the upper right, and choose My Credentials from the drop-down list.

4. On the My Credentials page, choose Access Keys in the left pane.

5. Click Create Access Key, verify your identity, and download the generated access key file.

6. Open the Excel file, enter the access key on the login page, and click Login.

7. If you do not have a HUAWEI ID, click create one on the Huawei Cloud AK/SK login page to go to the registration page.

8. Log in to the account by performing steps 3 to 6.

9. Browse cloud services and APIs in the left pane, and select one to view details on the right.

10. Click Homepage on the left of the Huawei Cloud APIs extension, and search cloud services, APIs, SDKs, and error codes.

11. Open a Java, JavaScript, TypeScript, or Go file, and enter an API name to try intelligent auto-completion.

12. Open a Java file, import the corresponding SDK package through intelligent auto-completion, and try Codelens.

13. Open a .sh or .bat script file, and enter 'hcloud ' to try KooCLI command auto-completion.

14. To switch the account, click Login Overview or Logout to log out, and then repeat steps 2 to 6.

Public IP Addresses to Use

• Huawei Cloud API Explorer: https://apiexplorer.cn-north-4.myhuaweicloud.com
• Huawei Cloud Nemo: https://nemo.cn-north-4.myhuaweicloud.com
• Huawei Cloud SDKs: https://sdkcenter.cn-north-4.myhuaweicloud.com
• Huawei Cloud Error Center: https://apierrorcenter.cn-north-4.myhuaweicloud.com
• Huawei Cloud Codelabs: https://codelabs.cn-north-4.myhuaweicloud.com
• Huawei Cloud KooCLI (Windows): https://cn-north-6-hdn-hwcloudcli.obs.cn-north-6.myhuaweicloud.com
• Huawei Cloud KooCLI (other OSs): https://hwcloudcli.obs.cn-north-1.myhwclouds.com
• Huawei Cloud API Explorer Documentation: https://apiexplorer.developer.huaweicloud.com
• Huawei Cloud Help Center: https://support.huaweicloud.com/en-us/
• Huawei Cloud Static Resource Library: https://res.hc-cdn.com
• Huawei Cloud OBS: https://obs.cn-north-4.myhuaweicloud.com
• Huawei Cloud IotDA: https://iotps.cn-north-4.myhuaweicloud.com
• Huawei Cloud IAM: https://iam.myhuaweicloud.com

Note: This extension supports only cloud services available on Huawei Cloud Chinese mainland website. For users both in and outside China who have purchased these cloud resources, their data will be stored in the Chinese mainland. For details, see Privacy Statement.