Skip to content

0-Overview.md

Latest commit

 

History

History
57 lines (38 loc) · 1.45 KB

0-Overview.md

File metadata and controls

57 lines (38 loc) · 1.45 KB
Raw

中文 | Overview

Volcengine Node.js SDK Integration Guide

Requirements

  • Node.js >= 18

Installation

It is recommended to use pnpm for installation, but npm and yarn are also supported.

  1. Install Core Package
# pnpm
pnpm add @volcengine/sdk-core

# npm
npm install @volcengine/sdk-core

# yarn
yarn add @volcengine/sdk-core

  1. Install Service SDK Package

    Take installing ECS service SDK package as an example:

# pnpm
pnpm add @volcengine/ecs

# npm
npm install @volcengine/ecs

# yarn
yarn add @volcengine/ecs

Section Index

  1. Credentials — AK/SK, STS, AssumeRole, OIDC, SAML, ECS role, default credential chain
  2. Endpoint Configuration — Custom endpoint, region ID, automatic resolution
  3. Transport — Protocol scheme, SSL verification, connection pool
  4. Proxy — HTTP(S) proxy configuration in code and environment variables
  5. Timeouts — Client timeout, per-request timeout, connect/read timeout split
  6. Retries — Retry conditions, backoff strategies, custom retry
  7. Error Handling — Exception types, error codes, resource cleanup
  8. Debugging — Debug options, log levels, custom middleware

中文 | Overview