You need to enable JavaScript to run this app.
文档中心
文档备案控制台
veImageX

veImageX

请输入
  • 文档首页
    • veImageX服务端 SDKNode.js SDK安装及初始化
复制全文
下载 pdf
我的收藏
Node.js SDK
安装及初始化
复制全文
下载 pdf
我的收藏
安装及初始化

veImageX 支持使用 SDK 完成 API 的调用，您可参考以下内容快速完成服务端 Node SDK 的安装及初始化操作。

前提条件

  • 已开通 veImageX 服务。
  • 已安装 Node 12.0.0 及以上版本，可通过 node -v 命令查看当前版本。
  • 已获取访问 veImageX 所需的 AK/SK。由于主账号 AK/SK 一旦泄漏，将有严重的安全风险，推荐您使用临时访问凭证来访问产品服务。

注意事项

为避免 AK/SK 泄漏，引起安全风险。建议您定期更换 AK 和 SK、使用访问策略限制权限、采用安全存储等方式提高安全性。

安装 SDK

示例如下所示。

// 使用npm
//命令中的 --save 会将模块写入应用的 package.json 文件中，作为依赖模块。
npm install @volcengine/openapi --save
// 使用yarn
yarn add @volcengine/openapi

初始化

veImageX 支持两种 AK 和 SK 的配置方式，在验证和测试阶段，您可以使用在业务代码中配置的方式，如果需要发布到生产环境，请使用在环境变量中配置的方式。

注意

在调用中，系统会自动读取配置参数，您在调试代码中配置的 AK 和 SK 优先级高于环境变量配置。

配置访问 AK/SK

  • 在 Linux 或 macOS 系统中配置

    请在命令行终端执行以下命令，并传入已准备好的 AK 和 SK。

export VOLC_ACCESSKEY="ak"
export VOLC_SECRETKEY="sk"

  • 在 Windows 系统中配置

    新建系统环境变量，添加环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，并传入已准备好的 AK 和 SK。

配置访问 Region

veImageX 支持以下两个地域：

  • cn-north-1：（默认）国内
  • ap-southeast-1：亚太东南（柔佛）

默认地域为中国（cn-north-1），若需调用其它地域服务，请在初始化时传入指定的地域信息。支持以下两种方式：

  1. 您可在创建新实例时，直接指定区域为ap-southeast-1。

    const imagexService = new imagex.imagexService({ region: "ap-southeast-1" })

  2. 您在使用默认实例时，区域默认为 cn-north-1，您可参考以下代码示例将区域修改为 ap-southeast-1。

    const imagexService = imagex.defaultService;
// 修改默认实例的区域
imagexService.setRegion("ap-southeast-1")

后续步骤

至此，您已成功完成 Node SDK 的安装和初始化。接下来，您可以参考各接口的调试示例来使用相应的能力。

相关操作

更新 SDK

执行以下命令将 SDK 更新至最新版本。

// 使用npm
npm install @volcengine/openapi --save
// 使用yarn
yarn add @volcengine/openapi
//或者
yarn upgrade @volcengine/openapi@latest
最近更新时间：2025.12.17 14:05:28
这个页面对您有帮助吗？
有用
有用
无用
无用