Skip to content

README.EN.md

Latest commit

 

History

History
94 lines (66 loc) · 2.02 KB

README.EN.md

File metadata and controls

94 lines (66 loc) · 2.02 KB

English | 中文

Volcengine SDK for Node.js

Requirements

  • Node.js >= 18

Installation

Recommended to use pnpm for installation. npm and yarn are also supported.

  1. Installation Core Packages
# pnpm
pnpm add @volcengine/sdk-core

# npm
npm install @volcengine/sdk-core

# yarn
yarn add @volcengine/sdk-core

  1. Installation Service Packages

    Take installing ECS service SDK package as an example:

# pnpm
pnpm add @volcengine/ecs

# npm
npm install @volcengine/ecs

# yarn
yarn add @volcengine/ecs

Environment Variables

The SDK automatically reads the following environment variables as access credentials:

  • VOLCSTACK_ACCESS_KEY_ID or VOLCSTACK_ACCESS_KEY: Access Key ID
  • VOLCSTACK_SECRET_ACCESS_KEY or VOLCSTACK_SECRET_KEY: Secret Access Key

After configuring environment variables, you do not need to configure credentials in the code again.

export VOLCSTACK_ACCESS_KEY_ID="YOUR_AK"
export VOLCSTACK_SECRET_ACCESS_KEY="YOUR_SK"

Quick Start

The following example shows how to initialize the client and send a request. Install the corresponding service SDK package (e.g., @volcengine/ecs).

# pnpm
pnpm add @volcengine/ecs
import { ECSClient, DescribeZonesCommand } from "@volcengine/ecs"; // Need to install the corresponding service package

// 1. Use AK/SK from environment variables and specify Region
const client = new ECSClient({
  region: "cn-beijing",
});

// 2. Or explicitly pass AK/SK in the code
// const client = new ECSClient({
//   accessKeyId: "YOUR_AK",
//   secretAccessKey: "YOUR_SK",
//   region: "cn-beijing",
// });

async function main() {
  try {
    // Send request (refer to service SDK documentation for specific Commands)
    const command = new DescribeZonesCommand({});
    const response = await client.send(command);
    console.log(response);
  } catch (error) {
    console.error("Error:", error);
  }
}

main();

For more code examples, please refer to: SDK Integration Documentation