一、依赖环境
1. Node.js 10.0.0 版本及以上。
2. 注意：部分产品需在 腾讯云控制台 开通服务后才能使用。
二、获取安装
使用 SDK 需要 API 密钥，可前往 腾讯云控制台 – 访问密钥 页面申请，API 密钥包括 SecretID 和 SecretKey，密钥须严格保管，避免泄露。
三、通过 npm 安装
通过 npm 获取安装是使用 Node.js SDK 的推荐方法，关于 npm 详细可参考 NPM 页面。
四、安装指定产品 SDK（推荐）
安装 CVM SDK：
npm install tencentcloud-sdk-nodejs-cvm –save
安装 VPC SDK：
npm install tencentcloud-sdk-nodejs-vpc –save
具体产品的缩写表请参考 products.md 中的包名字段。
安装指定产品 SDK 后，注意修改引入的包名：
– const tencentcloud = require("tencentcloud-sdk-nodejs")+ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")- const CvmClient = tencentcloud.cvm.v20170312.Client+ const CvmClient = cvm.v20170312.Client
五、安装全产品 SDK
npm install tencentcloud-sdk-nodejs –save
全产品 SDK 包含所有云产品调用代码和 TypeScript 类型文件，体积偏大。对于体积敏感的场景，推荐安装指定产品 SDK。
如果既希望全产品调用，又对包体积比较敏感，可以使用 Slim 版本 SDK。Slim SDK 移除类型文件，并进行了代码压缩，适合体积敏感场景使用：
npm install tencentcloud-sdk-slim-nodejs –save
六、通过源码包安装
1. clone 代码到本地：
git clone https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-nodejs# 或者git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs# 或者git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
2. 在项目根目录执行以下命令完成构建：
npm install && npm run build
3. 打包 NPM 压缩文件，例如 tencentcloud-sdk-nodejs-4.0.0.tgz：
npm pack
4. 安装包到你的项目里：
npm install /path/to/tencentcloud-sdk-nodejs/tencentcloud-sdk-nodejs-4.0.0.tgz
七、示例
以云服务器产品查询可用区列表接口为例。
const tencentcloud = require("tencentcloud-sdk-nodejs")// 导入对应产品模块的client models。const CvmClient = tencentcloud.cvm.v20170312.Client// 实例化要请求产品(以cvm为例)的client对象const client = new CvmClient({ // 为了保护密钥安全，建议将密钥设置在环境变量中或者配置文件中，请参考这篇凭证管理章节。 // 硬编码密钥到代码中有可能随代码泄露而暴露，有安全隐患，并不推荐。 credential: { secretId: process.env.TENCENTCLOUD_SECRET_ID, secretKey: process.env.TENCENTCLOUD_SECRET_KEY, }, // 产品地域 region: "ap-shanghai", // 可选配置实例 profile: { signMethod: "TC3-HMAC-SHA256", // 签名方法 httpProfile: { reqMethod: "POST", // 请求方法 reqTimeout: 30, // 请求超时时间，默认60s // proxy: "http://127.0.0.1:8899" // http请求代理 }, },})// 通过client对象调用想要访问的接口（Action），需要传入请求对象（Params）以及响应回调函数// 即：client.Action(Params).then(res => console.log(res), err => console.error(err))// 如：查询云服务器可用区列表client.DescribeZones().then( (data) => { console.log(data) }, (err) => { console.error("error", err) })
在支持 typescript 项目中，采用如下方式调用。
import * as tencentcloud from "tencentcloud-sdk-nodejs"const CvmClient = tencentcloud.cvm.v20170312.Client// …
实例化Client 的入参支持 clientConfig 数据结构和说明，详情请参见 ClientConfig。
八、Common Client
从 4.0.714 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。你只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
注意，你必须明确知道你调用的接口所需参数，否则可能会调用失败。
详细使用请参阅示例：使用 Common Client 进行调用。
九、更多示例
请参考 examples 目录。
十、代理
如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 profile.httpProfile.proxy 参数，或设置系统环境变量 http_proxy ，否则可能无法正常调用，抛出连接超时的异常。
十一、凭证管理
除显式传入凭证外，从 v4.0.506 起支持 腾讯云实例角色。
在你为实例绑定角色后，你可以在实例中访问相关元数据接口获取临时凭证。用法可参考 js示例代码 或 ts示例代码。
// …const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").defaultnew XxxClient({ // … credential: new CvmRoleCredential(), // …})
十二、常见问题
·webpack 打包出错/浏览器报错
请务必不要将此 SDK 直接用于 Web 前端（包括小程序等），暴露密钥在这些环境非常不安全。
正确做法是在自己的服务端引用此 SDK，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
·The "original" argument must be of type Function.
通常是因为 Node.js 版本低于 10.0.0 ，或处于非 Node.js 环境，请再次确认执行环境。
·请求不通
设置环境变量 NODE_DEBUG=http 来开启请求日志输出来定位问题，例如：
# MacOSNODE_DEBUG=http node app.js# windows cmdset NODE_DEBUG=http & node app.js# windows powershell$env:NODE_DEBUG='http' ; node app.js
如需要配置代理，请查阅上文代理配置，或设置环境变量 http_proxy，例如：
# MacOShttp_proxy=http://代理地址:代理端口 node app.js
·整数类型值超出 JavaScript 最大安全整数 使用新的数据类型 BigInt。