# @byteplus/vcloud-sdk-nodejs 中文文档

规范地址：https://npmcn.com/package/%40byteplus/vcloud-sdk-nodejs/

版本：1\.0\.7
npm 元数据更新时间：2026-09-22T06:17:11.366Z
中文译文更新时间：2026-11-08T22:03:11.580Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byteplus/vcloud-sdk-nodejs
原文对照：https://npmcn.com/package/%40byteplus/vcloud-sdk-nodejs/?lang=original
源码仓库：https://code.byted.org/vcloud-fe/vcloud-sdk-nodejs

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.3 MB，44 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16
- 运行依赖：12 个
- 首次发布：2025-02-10T08:12:21.462Z
- 最新版本发布：2025-11-19T02:43:12.560Z
- 近 30 天下载量：10551（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 2 个）

## 中文简介

节点J的 Vcloud 字节+ OpenAPI SDK

## 安装

```sh
npm install @byteplus/vcloud-sdk-nodejs
```

也可以使用：`pnpm add @byteplus/vcloud-sdk-nodejs`、`yarn add @byteplus/vcloud-sdk-nodejs`、`bun add @byteplus/vcloud-sdk-nodejs`

## README

# 字节Plus OpenAPI 节点Js SDK

## 所需经费:

-   节点.js 12

## 安装

```shell
npm install -S @byteplus/vcloud-sdk-nodejs
```

## 基本用途

### 1\. 设置 OpenAPI 服务的 AK&SK

有三种设置

#### 1\. 使用API设置 AK&SK

```ts
import { vodOpenapi } from "@byteplus/vcloud-sdk-nodejs";
// Use the default service instance.
const vodService = vodOpenapi.defaultService;

// set aksk
vodService.setAccessKeyId(AccessKeyId);
vodService.setSecretKey(SecretKey);
// If you use sts to request, you need to set up `SessionToken` after aksk is set
vodService.setSessionToken(SessionToken);
```

#### 2\. 使用环境变量设置 AK & SK

```shell
BYTEPLUS_ACCESSKEY="your ak" BYTEPLUS_SECRETKEY="your sk"
```

#### 3\. 使用配置文件

放进去 `~/.byteplus/config` ,格式为:

```
{"BYTEPLUS_ACCESSKEY":"your ak","BYTEPLUS_SECRETKEY":"your sk"}
```

## 请求 OpenAPI

以IAM服务的列表用户 API 为例

```ts
import { vodOpenapi } from "@byteplus/vcloud-sdk-nodejs";

async function main(AccessKeyId, SecretKey) {
  // Use the default service instance.
  const vodService = vodOpenapi.defaultService;

  // set aksk
  vodService.setAccessKeyId(AccessKeyId);
  vodService.setSecretKey(SecretKey);

  // Request OpenAPI
  const usersResponse = await vodService.ListUsers({
    Limit: 10,
    Offset: 0,
  });
}
```

## OpenAPI 签名方法

### 根据 HTTP 信头

```ts
import { Signer } from "@byteplus/vcloud-sdk-nodejs";

// http request data
const openApiRequestData: RequestObj = {
  region: "ap-singapore-1",
  method: "GET",
  // [optional] http request url query
  params: {},
  // http request headers
  headers: {},
  // [optional] http request body
  body: "",
};

const signer = new Signer(openApiRequestData, "vod");

// sign
signer.addAuthorization({ accessKeyId, secretKey, sessionToken });

// Print signed headers
console.log(openApiRequestData.headers);
```

### 由 HTTP 查询

```ts
const openApiRequestData: RequestObj = {
  method: "POST",
  region: "ap-singapore-1",
  params: {
    Action: "UpdateSubtitleStatus",
    Version: "2023-01-01",
    Vid: "your vid",
    Status: "your status",
    FileIds: "your fileIds",
    Formats: "your formats",
    Languages: "your languages",
  },
};

const credentials: Credentials = {
  accessKeyId: BYTEPLUS_ACCESSKEY,
  secretKey: BYTEPLUS_SECRETKEY,
  sessionToken: "",
};

const signer = new Signer(openApiRequestData, "vod");

const signedQueryString = signer.getSignUrl(credentials);
```

## 常见问题

### @byteplus/vcloud-sdk-nodejs 是什么？

节点J的 Vcloud 字节\+ OpenAPI SDK

### 如何安装 @byteplus/vcloud-sdk-nodejs？

在项目目录运行 npm install @byteplus/vcloud-sdk-nodejs，或使用 pnpm add / yarn add / bun add。

### @byteplus/vcloud-sdk-nodejs 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @byteplus/vcloud-sdk-nodejs 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @byteplus/vcloud-sdk-nodejs 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @byteplus/vcloud-sdk-nodejs 可以商用吗？

@byteplus/vcloud-sdk-nodejs 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @byteplus/vcloud-sdk-nodejs 的下载量有多少？

根据 npm 官方下载统计，@byteplus/vcloud-sdk-nodejs 在 2026/10/09 – 2026/11/07 这 30 天内被下载 10,551 次，日均约 352 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @byteplus/vcloud-sdk-nodejs 还在维护吗？

最新版本 1\.0\.7 发布于 2025/11/19（11 个月前）；至今共发布 8 个版本，其中过去 12 个月发布了 2 个；首次发布于 2025/02/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。