Skip to content

Latest commit

 

History

History
240 lines (173 loc) · 9.1 KB

README.md

File metadata and controls

240 lines (173 loc) · 9.1 KB
Raw

English | 简体中文

Huawei Cloud Node.js Software Development Kit (Node.js SDK)

The Huawei Cloud Node.js SDK allows you to easily work with Huawei Cloud services such as Elastic Compute Service (ECS) and Virtual Private Cloud (VPC) without the need to handle API related tasks.

This document introduces how to obtain and use Huawei Cloud Node.js SDK.

Requirements

  • To use Huawei Cloud Node.js SDK, you must have Huawei Cloud account as well as the Access Key (AK) and Secret key (SK) of the Huawei Cloud account. You can create an Access Key in the Huawei Cloud console. For more information, see My Credentials.

  • To use Huawei Cloud Node.js SDK to access the APIs of specific service, please make sure you do have activated the service in Huawei Cloud console if needed.

  • Huawei Cloud Node.js SDK requires Node 10.16.1 or later.

Install Node.js SDK

The recommended way to install SDK is with npm.

You must depended on @huaweicloud/huaweicloud-sdk-core library no matter which product/service development kit you need to use. Take using VPC SDK for example, you need to install @huaweicloud/huaweicloud-sdk-vpc library:

npm install @huaweicloud/huaweicloud-sdk-core
npm install @huaweicloud/huaweicloud-sdk-vpc

You can get the SDK version information through SDK center or NPM.

Code Example

  • The following example shows how to query vpcs, you need to substitute your real {Service}Client for VpcClient in actual use.
  • Substitute the values for {your endpoint}, {your project id}.
// index.ts
import { ListVpcsRequest, VpcClient } from "@huaweicloud/huaweicloud-sdk-vpc";
import { BasicCredentials } from "@huaweicloud/huaweicloud-sdk-core/auth/BasicCredentials";

// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK in the local environment.
const ak = process.env.HUAWEICLOUD_SDK_AK;
const sk = process.env.HUAWEICLOUD_SDK_SK;
const projectId = '{your project id}';
const endpoint = '{your endpoint}';

const credentials = new BasicCredentials()
  .withAk(ak)
  .withSk(sk)
  .withProjectId(projectId);

const client = VpcClient.newBuilder()
  .withCredential(credentials)
  .withEndpoint(endpoint)
  .build();


(async () => {
  try {
    const request = new ListVpcsRequest();
    const result = await client.listVpcs(request);
    console.log("Result:", JSON.stringify(result, null, 2));
  } catch (error:any) {
    console.error("Exception:", JSON.stringify(error, null, 2));
  }
})();
  • Debug the example above
# Add npm dependencies
npm install -g ts-node typescript

# Run the command
ts-node ./index.ts

Online Debugging

API Explorer provides api retrieval, SDK samples and online debugging, supports full fast retrieval, visual debugging, help document viewing, and online consultation.

Changelog

Detailed changes for each released version are documented in the CHANGELOG.md.

User Manual 🔝

1. Client Configuration 🔝

1.1 Default Configuration 🔝

// Use default configuration
const client = VpcClient.newBuilder()

1.2 Network Proxy 🔝

// Use proxy if needed
client.withProxyAgent("http://username:password@proxy.huaweicloud.com:8080")

1.3 SSL Certification 🔝

// Skip SSL certification checking while using https protocol if needed
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"

2. Credentials Configuration 🔝

There are two types of Huawei Cloud services, regional services and global services.

Global-level services include IAM, etc.

For Regional services' authentication, projectId is required.

For global services' authentication, domainId is required.

Parameter description:

  • ak is the access key ID for your account.
  • sk is the secret access key for your account.
  • projectId is the ID of your project depending on your region which you want to operate.
  • domainId is the account ID of HUAWEI CLOUD.
  • securityToken is the security token when using temporary AK/SK.

You could use permanent AK plus SK or use temporary AK plus SK plus SecurityToken to complete credentials' configuration.

2.1 Use Permanent AK&SK 🔝

// Regional Services
const basicCredentials = new BasicCredentials()
    .withAk(ak)
    .withSk(sk)
    .withProjectId(projectId)

// Global Services
const globalCredentials = new GlobalCredentials()
    .withAk(ak)
    .withSk(sk)
    .withDomainId(domainId)

2.2 Use Temporary AK&SK 🔝

It's required to obtain temporary AK&SK and security token first, which could be obtained through permanent AK&SK or through an agency.

// Regional Services
const basicCredentials = new BasicCredentials()
    .withAk(ak)
    .withSk(sk)
    .withSecurityToken(securityToken)
    .withProjectId(projectId)

// Global Services
const globalCredentials = new GlobalCredentials()
    .withAk(ak)
    .withSk(sk)
    .withSecurityToken(securityToken)
    .withDomainId(domainId)

3. Client Initialization 🔝

3.1 Initialize the {Service}Client with specified Endpoint 🔝

const client = VpcClient.newBuilder()
    .withCredential(basicCredentials)
    .withEndpoint(endpoint)
    .withProxyAgent(proxy)
    .build()

where:

4. Send Requests and Handle Responses 🔝

const result = client.showJobDetail(new ShowJobDetailRequest("id"));
result.then(result => {
    res.send("JSON.stringify(result)::" + JSON.stringify(result))
}).catch(ex => {
    res.send("exception:" + JSON.stringify(ex))
});

5. Troubleshooting 🔝

5.1 Original HTTP Listener 🔝

In some situation, you may need to debug your http requests, original http request and response information will be needed. The SDK provides a listener function to obtain the original encrypted http request and response information.

⚠️ Warning: The original http log information is used in debugging stage only, please do not print the original http header or body in the production environment. This log information is not encrypted and contains sensitive data such as the password of your ECS virtual machine, or the password of your IAM user account, etc. When the response body is binary content, the body will be printed as "***" without detailed information.

Set the environment variable process.env.DEBUG to enable debug log printing.