跳到主要内容

环境管理

listEnvs​

1. 接口描述​

接口功能：获取所有环境信息

接口声明：listEnvs(): Promise<Object>

2. 输入参数​

无

3. 返回结果​

字段必填类型说明
RequestId是String请求唯一标识
EnvList是Array<EnvItem>环境数组

EnvItem​

字段必填类型说明
EnvId是String环境 ID
Source是String来源
Alias是String环境别名
Status是String环境状态
CreateTime是String创建时间
UpdateTime是String更新时间
PackageId是String环境套餐 ID
PackageName是String套餐名
Databases是Array数据库资源详情
Storages是Array存储资源详情
Functions是Array函数资源详情
LogServices是Array日志资源详情

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.listEnvs()
  const { EnvList } = res
  for (let env in EnvList) {
    // 遍历envList
    console.log(env)
  }
}

test()

getEnvAuthDomains​

1. 接口描述​

接口功能：获取合法域名列表

接口声明：getEnvAuthDomains(): Promise<Object>

2. 输入参数​

无

3. 返回结果​

字段必填类型说明
Domains是Array<Domain>域名列表
envId是String环境 ID

Domain

字段必填类型说明
Id是String域名 ID
Domain是String域名
Type是String域名类型。包含以下取值：system user
Status是String状态。包含以下取值：ENABLE DISABLE
CreateTime是String创建时间
UpdateTime是String更新时间

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.getEnvAuthDomains()
  const { Domains } = res
  for (let domain in Domains) {
    console.log(domain)
  }
}

test()

createEnvDomain​

1. 接口描述​

接口功能：添加环境安全域名

接口声明：createEnvDomain(domains: string[]): Promise<Object>

2. 输入参数​

字段必填类型说明
domains是Array<String>安全域名数组

3. 返回结果​

字段类型说明
RequestIdString请求 ID

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.createEnvDomain(['luke.com'])
  console.log(res)
}

test()

deleteEnvDomain​

1. 接口描述​

接口功能：删除环境安全域名

接口声明：deleteEnvDomain(domains: string[]): Promise<Object>

2. 输入参数​

字段必填类型说明
domains是Array<String>安全域名数组

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID
Deleted是Number删除成功的域名数

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.deleteEnvDomain(['luke.com'])
  const { Deleted } = res
  console.log(Deleted) // 删除域名数
}

test()

getEnvInfo​

1. 接口描述​

接口功能：获取环境信息

接口声明：getEnvInfo(): Promise<Object>

2. 输入参数​

无

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID
EnvInfo是EnvItem环境信息

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.getEnvInfo()
  const { EnvInfo } = res
  console.log(EnvInfo)
}

test()

updateEnvInfo​

1. 接口描述​

接口功能：修改环境别名

接口声明：updateEnvInfo(alias: string): Promise<Object>

2. 输入参数​

字段必填类型说明
alias是String环境别名

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.updateEnvInfo('lukemodify')
  console.log(res)
}

test()

getLoginConfigList​

1. 接口描述​

接口功能：拉取登录配置列表

接口声明：getLoginConfigList(): Promise<Object>

2. 输入参数​

无

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID
ConfigList是Array<ConfigItem>登录配置列表

ConfigItem​

字段必填类型说明
Id是String配置 ID
Platform是String平台类型
PlatformId是String平台 ID
Status是String配置状态
UpdateTime是String配置更新时间
CreateTime是String配置创建时间

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.getLoginConfigList()
  const { ConfigList } = res
  for (let config in ConfigList) {
    console.log(config)
  }
}

test()

createLoginConfig​

1. 接口描述​

接口功能：创建登录方式

接口声明：createLoginConfig(platform, appId, appSecret): Promise<Object>

2. 输入参数​

字段必填类型说明
platform是String平台 "WECHAT-OPEN" "WECHAT-PUBLIC" "QQ" "ANONYMOUS"
appId是String第三方平台的 AppID 注意:如果是匿名登录方式(platform:ANONYMOUS),appId 填: anonymous
appSecret否String第三方平台的 AppSecret，注意:如果是 匿名登录方式(platform:ANONYMOUS)， appSecret 可不填

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  await env.createLoginConfig('WECHAT-OPEN', 'appId', 'appSecret')
}

test()

updateLoginConfig​

1. 接口描述​

接口功能：更新登录方式配置

接口声明：updateLoginConfig(configId, status, appId, appSecret): Promise<Object>

2. 输入参数​

字段必填类型说明
configId是String配置的记录 ID
status是String”ENABLE”, “DISABLE”
appId是String第三方平台的 AppId，如果是匿名登录， appId 填: anonymous
appSecret否String第三方平台的 AppSecret，如果是匿名登录，可不填该字段

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const loginConfigRes = await env.getLoginConfigList()
  await env.updateLoginConfig(
    loginConfigRes.ConfigList[0].Id,
    'ENABLE',
    'appId',
    'appSecret'
  )
}

test()

createCustomLoginKeys​

1. 接口描述​

接口功能：创建自定义登录密钥

接口声明：createCustomLoginKeys(): Promise<Object>

2. 输入参数​

无

3. 返回结果​

字段必填类型说明
RequestId是String请求 ID
KeyID是String密钥 ID
PrivateKey是String私钥

4. 示例代码​

import CloudBase from '@cloudbase/manager-node'

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

async function test() {
  const res = await env.createCustomLoginKeys()
  const { KeyID, PrivateKey } = res
  console.log(KeyID, PrivateKey)
}

test()