@serverless/utils-china
Advanced tools
目前腾讯云有很多部分不能彻底满足 Serverless Framework，所以针对 Serverless Framework 做了很多基础能力的建设。建设的这些成果，都会统一增加到该 SDK 中。
基本使用方法(开启调试和实时日志)：
const { Debug } = require('@serverless/utils-china');
const region = 'ap-aaaaa';
const auth = {
SecretId: '****',
SecretKey: '*****',
};
const func = {
functionName: 'course',
};
const sdk = new Debug(auth, func, region);
// 开启调试和实时日志
await sdk.remoteDebug();
// 开启调试的标准接口（推荐使用）
try {
await sdk.standardRemoteDebug({
logger: console.log,
stdout: process.stdout,
});
} catch (e) {
console.error(e);
}
// 调试后结束
await sdk.stop();
输出结果：无
输入参数：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| auth | 是 | - | 鉴权信息 |
| func | 是 | - | 函数信息 |
| region | 否 | ap-guangzhou | 地域 |
auth 参数描述：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| SecretId | 是 | - | 用户密钥 Id |
| SecretKey | 是 | - | 用户密钥 Key |
| token | 否 | - | 临时密钥需要传递此参数 |
func 参数描述：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| functionName | 是 | - | 地域 |
| nameSpace | 否 | default | 命名空间 |
| qualifier | 否 | $LATEST | 版本 |
输出参数：
无输出。调试和实时日志能力都集成在接口里面实现
基本使用方法(getAddr)：
const { Logs } = require('@serverless/utils-china');
const scfRealTimeLogs = Logs.ScfRealTimeLogs;
const region = 'ap-aaaaa';
const auth = {
SecretId: '****',
SecretKey: '*****',
};
const func = {
functionName: 'course',
};
console.log(scfRealTimeLogs.getAddr(auth, func, region));
输出结果：
ws://service-qwh371t8-1258344699.gz.apigw.tencentcs.com/release/websocket?Action=GetFunctionLogs&FunctionName=course&Namespace=default&Nonce=32932&Qualifier=$LATEST&Region=ap-guangzhou&RequestClient=ServerlessFramework&SecretId=AKID1ynRAoVcoqrDUbwR9RbcS7mKrOl1q0kK&Signature=crrcT%2B6y%2FYIZecEKyd8GgWQ0BM%2B%2FOdH3E4ZbjDddFHo%3D&SignatureMethod=HmacSHA256&Timestamp=1576723081&Version=2018-04-16&Timeout=600&AppidSignature=%26Action%3DGetUserAppId%26Nonce%3D44632%26Region%3Dap-guangzhou%26RequestClient%3DSDK_NODEJS_3.0.104%26SecretId%3DAKID1ynRAoVcoqrDUbwR9RbcS7mKrOl1q0kK%26Signature%3DO6xzhZZYm7j%252F9XROAcRAUpBFgNyXSj0dYer2JK8yfB8%253D%26SignatureMethod%3DHmacSHA256%26Timestamp%3D1576723081%26Version%3D2019-01-16
输入参数：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| region | 否 | ap-guangzhou | 地域 |
| auth | 是 | - | 鉴权信息 |
| func | 是 | - | 函数信息 |
| timeout | 否 | 600s | 超时时间（超过 600s 停止日志获取） |
auth 参数描述：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| SecretId | 是 | - | 用户密钥 Id |
| SecretKey | 是 | - | 用户密钥 Key |
| token | 否 | - | 临时密钥需要传递此参数 |
func 参数描述：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| functionName | 是 | - | 地域 |
| nameSpace | 否 | default | 命名空间 |
| qualifier | 否 | $LATEST | 版本 |
输出参数：
出参只有一个 websocket 地址，只需要对此地址发起 websocket 请求即可获得到实时日志。
通过此接口，可以获得到用户的基本信息，包括 Appid，Uin 和主账号 Uin
基本使用方法(getUserInformation)：
const {
Cam: { GetUserInformation },
} = require('@serverless/utils-china');
class UserInformation {
async getUserInformation() {
const userInformation = new GetUserInformation();
const auth = {
SecretId: '****',
SecretKey: '****',
};
console.log(await userInformation.getUserInformation(auth));
}
}
const getUserInformation = new UserInformation();
getUserInformation.getUserInformation();
输出结果：
GetUserInformationResponse {
RequestId: 'd10abbd5-300a-4436-ab6b-9f3db0fcf011',
OwnerUin: '100005358439',
Uin: '100005358439',
AppId: 1256773370
}
输入参数：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| SecretId | 是 | - | 用户密钥 Id |
| SecretKey | 是 | - | 用户密钥 Key |
| token | 否 | - | 临时密钥需要传递此参数 |
输出参数：
| 参数 | 描述 |
|---|---|
| RequestId | 请求 Id |
| OwnerUin | OwnerUin |
| Uin | 用户 Uin |
| AppId | 用户的 AppId |
通过该功能可以通过扫码获取临时密钥，并进行相关操作。
基本使用方法（login）:
const { Login } = require('@serverless/utils-china');
class doLogin {
async login() {
const login = new Login();
const tencent_credentials = await login.login();
console.log(tencent_credentials);
}
}
const tencentLogin = new doLogin();
tencentLogin.login();
输出结果：
这里会展示一个二维码
Please scan QR code login from wechat.
Wait login...
Login successful for TencentCloud.
{
secret_id: '*********',
secret_key: '*********',
token: '*********',
appid: 1253970226,
signature: '*********',
expired: 1576744591,
uuid: '*********'
}
输出参数：
| 参数 | 描述 |
|---|---|
| secret_id | 临时 SecretId |
| secret_key | 临时 SecretKey |
| token | token, 临时密钥使用云 API 时，需要此参数参与签名 |
| appid | 用户的 AppId |
| signature | 签名，用于更新临时密钥，一次有效 |
| expired | 服务端密钥生成时间戳 |
| uuid | uuid，用于更新临时密钥，一次有效 |
上述方法获得到密钥对有效期为 2 小时，2 小时之后会自动过期，此时可以从新扫码登录，也可以刷新密钥对：
基本使用方法(flush)：
const { Login } = require('@serverless/utils-china');
class doLogin {
async flush() {
const login = new Login();
const uuid = '*********';
const expired = 1576744591;
const signature = '*********';
const appid = 1253970226;
const tencent_credentials = await login.flush(uuid, expired, signature, appid);
console.log(tencent_credentials);
}
}
const tencentLogin = new doLogin();
tencentLogin.flush();
输出结果：
{
appid: '1253970226',
expired: 1576745081,
secret_id: '***********',
secret_key: '*********',
signature: '*********',
success: true,
token: '********'
}
输入参数：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| uuid | 是 | - | uuid, 使用一键登录时可获得到此参数 |
| expired | 是 | - | 服务端时间戳, 使用一键登录时可获得到此参数 |
| signature | 是 | - | 签名, 使用一键登录时可获得到此参数，一次有效 |
| appid | 是 | - | 用户的 AppId |
输出参数：
| 参数 | 描述 |
|---|---|
| secret_id | 临时 SecretId |
| secret_key | 临时 SecretKey |
| token | token, 临时密钥使用云 API 时，需要此参数参与签名 |
| appid | 用户的 AppId |
| signature | 签名，用于更新临时密钥，一次有效 |
| expired | 服务端密钥生成时间戳 |
| success | 刷新状态 |
除了在命令行（终端）中使用一键登录，一键登录功能也适用于网页中二维码登录。
基本使用方法(loginUrl)：
const { Login } = require('@serverless/utils-china');
class doLogin {
async getUrl() {
const login = new Login();
console.log(await login.loginUrl());
}
}
const tencentLogin = new doLogin();
tencentLogin.getUrl();
输出结果：
{
login_status_url: '/login/status?uuid=***********&os=Darwin&expired=1576752276&signature=***********',
uuid: '***********',
url: 'https://cloud.tencent.com/open/authorize?scope=login&app_id=100005789219&redirect_url=http%3A%2F%2Fscfdev.tencentserverless.com%2Flogin%2Fsuccess%3Fuuid%3D***********%26os%3DDarwin%26expired%3D1576752276%26key%***********',
short_url: 'https://url.cn/5kbghL'
}
输出参数：
| 参数 | 描述 |
|---|---|
| login_status_url | 用户获取结果 |
| uuid | 生成的 uuid，用户获取结果 |
| url | 原始地址 |
| short_url | 短网址 |
在获得到上述地址之后，可以打开url或者short_url的地址进行授权（也可以将则个地址转化为二维码进行扫码授权），授权之后可以通过以下方法获取结果。
基本使用方法(checkStatus)：
const { Login } = require('@serverless/utils-china');
class doLogin {
async getResult() {
const login = new Login();
const uuid = '***********';
const login_status_url =
'/login/status?uuid=**********&os=Darwin&expired=1576752024&signature=*********';
console.log(await login.checkStatus(uuid, login_status_url));
}
}
const tencentLogin = new doLogin();
tencentLogin.getResult();
输出结果：
{
appid: '1253970226',
expired: 1576745081,
secret_id: '***********',
secret_key: '*********',
signature: '*********',
success: true,
token: '********'
}
输出参数：
| 参数 | 描述 |
|---|---|
| secret_id | 临时 SecretId |
| secret_key | 临时 SecretKey |
| token | token, 临时密钥使用云 API 时，需要此参数参与签名 |
| appid | 用户的 AppId |
| signature | 签名，用于更新临时密钥，一次有效 |
| expired | 服务端密钥生成时间戳 |
| uuid | uuid，用于更新临时密钥，一次有效 |
通过此接口，可以判断用户是否在腾讯云实名认证
基本使用方法(isRealNameVerified)：
const {
Account: { isRealNameVerified },
} = require('@serverless/utils-china');
const isVerified = await isRealNameVerified({ secretId, secretKey });
输出结果：
true or false
输入参数：
| 参数 | 必须 | 默认 | 描述 |
|---|---|---|---|
| secretId | 是 | - | tencent secret id |
| secretKey | 是 | - | tencent secret key |
| token | 否 | - | tencent auth token, 当使用临时 secretId 和 secretKey 时，此参数必须 |
该接口可以判断是否是中国用户
基本使用方法(IsInChina)：
const { Others } = require('@serverless/utils-china');
class OthersAction {
async getIsInChina() {
const isInChina = new Others.IsInChina();
const inChina = await isInChina.inChina();
console.log(inChina);
}
}
new OthersAction().getIsInChina();
输出结果：
{
IsInChina: true;
}
输出参数：
| 参数 | 描述 |
|---|---|
| IsInChina | 输出参数 true 或 false，如果是 true，表示是中国用户，否则表示非中国用户 |
serverless api
const { Serverless } = require('@serverless/utils-china');
const sls = new Serverless({
appid: app_id,
secret_id: secret_id,
secret_key: secret_key,
options: {
region: 'ap-guangzhou',
token: 'xxxxxx',
},
});
let ret = await sls.getComponentAndVersions('Component name');
console.log(ret);
// the getComponentAndVersions/getComponentVersion is public
ret = await Serverless.getComponentAndVersions('name', { region: 'ap-guangzhou' } /*optional*/);
console.log(ret);
ret = await Serverless.getComponentVersion(
'name',
'version',
{ region: 'ap-guangzhou' } /*optional*/
);
console.log(ret);
// send coupon
// now only support chars 'cos-2020-06'
ret = await sls.sendCoupon(['cos-2020-06']);
console.log(ret);
// request success ReturnCode=0
// SendCouponResponse {
// Msg: 'account already sent coupon',
// ReturnCode: 400,
// RequestId: 'c360feb7-cdc7-409f-ac60-d01f185c3b65'
// }
ret = await sls.postPublishPackage('JSON stringified object');
ret = await sls.preparePublishPackage('JSON stringified object');
// public
ret = await Serverless.getPackage('name', '0.01', { region: 'ap-shanghai' } /*optional*/);
ret = await Serverless.listPackages(
'JSON stringified object',
{ region: 'ap-shanghai' } /*optional*/
);
const { Serverless } = require('@serverless/utils-china');
const sls = new Serverless({
appid: app_id,
secret_id: secret_id,
secret_key: secret_key,
options: {
region: 'ap-guangzhou',
token: 'xxxxxx',
},
});
sls.getCacheFileUrls({
orgUid,
appName,
stageName,
instanceName,
});
const { SlsMonitor } = require('@serverless/utils-china');
const slsClient = new SlsMonitor({
appid: app_id,
secret_id: secret_id,
secret_key: secret_key,
options: {
region: 'ap-guangzhou',
token: 'xxxxxx',
},
});
const rangeTime = {
rangeStart: 'begin Time', // format string `2020-04-14T16:19:41+08:00`
rangeEnd: 'end Time', // format string `2020-04-15T16:19:41+08:00`
};
const period = 3600;
const ret = await slsClient.getScfMetrics(
'ap-guangzhou',
rangeTime,
period,
'funcName',
'default',
'$latest'
);
console.log(ret);
// report custom monitor metrics
const metrics = [
{
MetricName: 'metric_name',
Value: 1,
},
{
MetricName: 'metric_name',
Value: 1,
},
];
try {
await slsClient.putMonitorData(
metrics,
'instance',
'announceIp' /*optional*/,
'timestamp' /*optional*/
);
} catch (e) {
console.log(e);
}
const { Cls } = require('@serverless/utils-china');
// log array
const logs = [
{
key: 'err_msg',
value: 'error message',
},
// more...
];
const cred = {
secret_id: '',
secret_key: '',
options: {
region: 'ap-shanghai',
},
};
try {
const clsClient = new Cls(cred);
// deliver log set to cls, if success return empty string
const ret = await clsClient.structuredLog(
'topic_id',
logs,
'timestamp' /*optional default current timestamp*/,
'filename' /*optional default value 'default'*/,
'source' /*optional default value ''*/
);
} catch (e) {
console.log(e);
}
参考地址: https://cloud.tencent.com/document/product/248/31649
const { Ci } = require('@serverless/utils-china');
const ciClient = new Ci({
secret_id: '',
secret_key: '',
options: {
region: 'ap-shanghai', // now only support shanghai
},
});
let result = await ciClient.createProject({
name: 'ci project',
alias: 'serverless cicd',
description: 'serverless cicd project',
});
result = await ciClient.createCodingCIJob('job name', result.ProjectId, depot_id, {
TENCENT_SECRET_ID: '',
TENCENT_SECRET_KEY: '',
});
// start ci build job
result = await ciClient.triggerCodingCIJobBuild(result.Data.Id, {
CODE_URL_COS: 'code url',
});
result = await ciClient.describeCodingCIBuildStatus(result.Data.Build.Id);
let stages = JSON.parse(result.Data.StageJsonString);
console.log(stages);
// get build all log
result = await ciClient.describeCodingCIBuildLog(result.Data.Build.Id, offset);
console.log(result.Data.Log);
通过此接口，可以绑定 sls 服务使用的角色和策略
基本使用方法(bindQCSRole)：
'use strict';
const { BindRole } = require('../sdk/cam/index').BindRole;
class Role {
async bindSLSQCSRole() {
try {
const resp = await new BindRole({
SecretId: '',
SecretKey: '',
}).bindQCSRole();
console.log(resp);
} catch (e) {
console.log(e.toString());
}
}
}
const role = new Role();
role.bindSLSQCSRole();
通过此接口，可以绑定 sls 服务使用的角色和策略，默认返回的是[null]，如果有错误的话会抛出异常
基本使用方法(forceBindQCSRole)：
'use strict';
const { BindRole } = require('../sdk/cam/index').BindRole;
class Role {
async bindSLSQCSRole() {
try {
const resp = await new BindRole({
SecretId: '',
SecretKey: '',
}).forceBindQCSRole();
console.log(resp);
} catch (e) {
console.log(e.toString());
}
}
}
const role = new Role();
role.bindSLSQCSRole();
（* 该接口目前为 1.0 版本，后期会增加其复杂度，但是接口规范不会变。）
Copyright (c) 2019-present Tencent Cloud, Inc.
FAQs
Tencent Cloud Tools For Serverless Framewoek
The npm package @serverless/utils-china receives a total of 70,879 weekly downloads. As such, @serverless/utils-china popularity was classified as popular.
We found that @serverless/utils-china demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.