vcloud-sdk-nodejs v1.3.21

视频云对外 sdk 的 nodejs 版本。

vcloud-sdk-nodejs

封装了签名、发送请求等核心业务逻辑 ; 同时内置了 Vod和ImageX 标准 API

安装

//use npm
npm install vcloud-sdk-nodejs --save
//use yarn
yarn add vcloud-sdk-nodejs

基本使用方式：

const Client = require('vcloud-sdk-nodejs');

const clientOptions = {
  service: '<serviceName>',
  accesskey: '<accessKeyId>',
  secretkey: '<accessKeySecret>',
  version: '<apiVersion>'
  endpoint?: '<endpoint>', //默认是 https://open.bytedanceapi.com
}

const client = new Client(clientOptions);

const requestOptions = {
  method: string;  // set the http method, default is GET
  version: string; // api version; default is service apiVersion
  logId?: string; // requestId
  lockTime?: boolean; // aws签名时是否锁定时间戳, 默认是fase
  body?: any; //请求体，当method为get、options等无body的请求方法时设置无效
  query?: {  //url请求参数
    [key: string]: any;
  };
  headers?: {  //自定义请求头
    [key: string]: string;
  };
};

client.request(action, requestOptions);

添加拦截器

支持在 client 请求接口的前后添加拦截器, 继续以上文声明的 client 实例为例

//添加前置拦截器
client.addPreHandler({
  resolve: ({action, params}) => Promise({action, params}),
  reject: err => {}
});

//添加后置拦截器
client.addPostHandler({
  resolve: (response) => Promise(response),
  reject: err => {}
})

standard sdk

standard sdk 指的是和具体服务相关的 sdk，提供给用户更快捷的使用方式。以 Vod 服务的使用为例：

const VodClient = require('vcloud-sdk-nodejs/services/vod');

const client = new VodClient({
    accesskey: '<accessKeyId>',
    secretkey: '<accessKeySecret>',
  });

  const res = await client.GetPlayInfo();
}

API

SignSts2([inlinePolicy,expire])

• inlinePolicy [Policy](https://github.com/TTvcloud/vcloud-sdk-nodejs/blob/master/src/models/service.ts) 策略声明, 可不传 ; 默认允许对所有资源的操作
• expire: 过期时间(ms), 可不传，默认1小时

const Client = require("vcloud-sdk-nodejs");

const client = new Client({
    accesskey: '<accessKeyId>',
    secretkey: '<accessKeySecret>',
});

//默认的policy
const policy = {
  Statement: [
    {
      Effect: 'Allow',
      Action: ['*'],
      Resource: ['*'],
    },
  ],
};

client.SignSts2();  //无参数，expire将使用默认值

client.SignSts2(policy); //只传递policy对象， expire将使用默认值

client.SignSts2(600 * 1000); //只传递expire时间

client.SignSts2(policy, 600 * 1000); //传递policy和expire

方法返回值是一个对象类型， 包含了 aws 签名所需信息， 如下所示：

{
  CurrentTime: '20191121T102857Z',
  ExpiredTime: '20191121T112857Z',
  SessionToken: 'xxx',
  AccessKeyId: 'xxx',
  SecretAccessKey: 'xxx'
}

• CurrentTime： sessionToken 起始时间
• ExpiredTime： sessionToken 的过期时间
• SessionToken: aws v4 签名的 Session Token
• AccessKeyId: aws v4 签名的 AccessKey
• SecretAccessKey: aws v4 签名的 SecretKey