跳到主要内容

安全来源

安全规则的接口,可通过 commonService 来调用

新增安全来源

1. 接口描述

接口功能:新增安全来源

接口声明:manager.commonService().call({ Action: 'CreateSafetySource', Param: {}}): Promise<Object>

⚠️ 本接口从 3.0.0 版本后,commonService 作为方法使用,请求参数为(service?:string, version?:string) ,属于不兼容变更

2. 输入参数

字段必填类型说明
EnvIdString环境 ID
AppNameString应用标识

3. 返回结果

字段必填类型说明
RequestIdString请求唯一标识

4. 示例代码

import CloudBase from '@cloudbase/manager-node'

const manager = new CloudBase({
secretId: 'Your SecretId',
secretKey: 'Your SecretKey',
envId: 'Your envId' // 云开发环境ID,可在腾讯云云开发控制台获取
})

async function test() {
await manager.commonService().call({
Action: 'CreateSafetySource',
Param: { EnvId: 'Your envId', AppName: 'xxx' }
})
}

test()

获取安全来源列表

1. 接口描述

接口功能:获取安全来源列表

接口声明:manager.commonService().call({ Action: 'DescribeSafetySource', Param: {}}): Promise<Object>

⚠️ 本接口从 3.0.0 版本后,commonService 作为方法使用,请求参数为(service?:string, version?:string) ,属于不兼容变更

2. 输入参数

字段必填类型说明
EnvIdString环境 ID
OffsetNumber偏移量
LimitNumber限制数目

3. 返回结果

字段必填类型说明
TotalCountNumber总数
DataArray<SafetySourceItem>安全来源列表
RequestIdString请求唯一标识

SafetySourceItem 字段说明

字段必填类型说明
IdString记录 ID
AppNameString应用标识
AppSecretVersionString密钥版本
CreateTimeString创建时间

4. 示例代码

import CloudBase from '@cloudbase/manager-node'

const manager = new CloudBase({
secretId: 'Your SecretId',
secretKey: 'Your SecretKey',
envId: 'Your envId' // 云开发环境ID,可在腾讯云云开发控制台获取
})

async function test() {
const res = await manager.commonService().call({
Action: 'DescribeSafetySource',
Param: {
EnvId: 'Your envId',
Offset: 0,
Limit: 20
}
})
const { Data } = res
for (let item in Data) {
console.log(item)
}
}

test()

查看安全来源的密钥

1. 接口描述

接口功能:查看安全来源的密钥

接口声明:manager.commonService().call({ Action: 'DescribeSafetySourceSecretKey', Param: {}}): Promise<Object>

⚠️ 本接口从 3.0.0 版本后,commonService 作为方法使用,请求参数为(service?:string, version?:string) ,属于不兼容变更

2. 输入参数

字段必填类型说明
EnvIdString环境 ID
ItemIdObject记录 ID,从列表接口的返回数据里看

3. 返回结果

字段必填类型说明
RequestIdString请求唯一标识
AppSecretKeyString凭证

4. 示例代码

import CloudBase from '@cloudbase/manager-node'

const manager = new CloudBase({
secretId: 'Your SecretId',
secretKey: 'Your SecretKey',
envId: 'Your envId' // 云开发环境ID,可在腾讯云云开发控制台获取
})

async function test() {
const res = await manager.commonService().call({
Action: 'DescribeSafetySource',
Param: { EnvId: envId, Offset: 0, Limit: 20 }
})

const res1 = await manager.commonService().call({
Action: 'DescribeSafetySourceSecretKey',
Param: {
EnvId: envId,
ItemId: res.Data[0].Id
// APIId: apiId
}
})
console.log(res1.AppSecretKey)
}

test()

删除安全来源

1. 接口描述

接口功能:删除安全来源

接口声明:manager.commonService().call({ Action: 'DeleteSafetySource', Param: {}}): Promise<Object>

⚠️ 本接口从 3.0.0 版本后,commonService 作为方法使用,请求参数为(service?:string, version?:string) ,属于不兼容变更

2. 输入参数

字段必填类型说明
EnvIdString环境 ID
ItemIdObject记录 ID,从列表接口的返回数据里看

3. 返回结果

字段必填类型说明
RequestIdString请求唯一标识

4. 示例代码

import CloudBase from '@cloudbase/manager-node'

const manager = new CloudBase({
secretId: 'Your SecretId',
secretKey: 'Your SecretKey',
envId: 'Your envId' // 云开发环境ID,可在腾讯云云开发控制台获取
})

async function test() {
const res = await manager.commonService().call({
Action: 'DescribeSafetySource',
Param: { EnvId: envId, Offset: 0, Limit: 20 }
})

// 删除第一个安全来源
await commonService.call({
Action: 'DeleteSafetySource',
Param: { EnvId: envId, ItemId: res.Data[0].Id }
})
}

test()