跳到主要内容

HTTP Service

HTTP Service 是云开发为开发者提供的 HTTP 访问服务,让开发者可以通过 HTTP 访问到自己的云开发资源。

HTTP Service 的接口,可通过 commonService 来调用

创建云函数 HTTPService#

1. 接口描述#

接口功能:创建云函数 HTTPService

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

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

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
PathString自定义路径
TypeNumberservice type ,云函数默认为 1
NameString函数名

3. 返回结果#

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

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: 'CreateCloudBaseGWAPI',    Param: { ServiceId: envId, Path: '/sum', Type: 1, Name: 'sum' }  })  const { APIId } = res  console.log(APIId)}
test()

查询云函数 HTTP Service#

1. 接口描述#

接口功能:查询云函数 HTTP Service

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

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

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
DomainString绑定的域名
PathString自定义路径
APIIdStringAPIId

ServiceId 与 Domain 至少要设置其中一个字段!

3. 返回结果#

字段必填类型说明
RequestIdString请求唯一标识
APISetArray<CloudBaseGWAPI>HTTP service 列表

CloudBaseGWAPI

字段必填类型说明
ServiceIdString环境 ID
APIIdStringAPIId
PathString自定义路径
TypeNumberservice type ,云函数默认为 1
NameString云函数名
CreateTimeNumberservice 创建时间
EnvIdString环境 ID

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: 'DescribeCloudBaseGWAPI',    Param: {      ServiceId: envId,      Path: '/sum'    }  })  const { APISet } = res  for (let api in APISet) {    console.log(api)  }}
test()

删除云函数 HTTP Service#

1. 接口描述#

接口功能:删除云函数 HTTP Service

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

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

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
PathString自定义路径
APIIdStringAPIId

3. 返回结果#

字段必填类型说明
RequestIdString请求唯一标识
CountNumber被删除的 HTTP Service 个数

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: 'DeleteCloudBaseGWAPI',    Param: {      ServiceId: envId,      Path: '/sum'      // APIId: apiId    }  })  console.log(res.Count)}
test()

绑定 HTTP Service 自定义域名#

1. 接口描述#

接口功能:绑定 HTTP Service 自定义域名

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

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

绑定自定义域名时,请务必在您的自定义域名厂商处 配置 CNAME 域名解析

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
DomainString绑定的域名
CertIdString证书 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() {  await manager.commonService().call({    Action: 'BindCloudBaseGWDomain',    Param: {      ServiceId: envId,      Domain: 'xxx.xxx.xxx'    }  })}
test()

查询 HTTP Service 域名#

1. 接口描述#

接口功能:查询 HTTP Service 域名

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

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

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
DomainString绑定的域名

ServiceId 与 Domain 至少要设置其中一个字段!

3. 返回结果#

字段必填类型说明
RequestIdString请求唯一标识
ServiceSetArray<CloudBaseGWService>HTTP Service 域名信息

CloudBaseGWService

字段必填类型说明
ServiceIdString请求唯一标识
DomainStringHTTP Service 域名信息
OpenTimeNumberservice 开启时间
StatusNumber绑定状态,1 绑定中;2 绑定失败;3 绑定成功
注意:此字段可能返回 null,表示取不到有效值。

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: 'DescribeCloudBaseGWService',    Param: {      ServiceId: envId    }  })  const { Domain } = res  console.log(Domain)}test()

解绑 HTTP Service 域名#

1. 接口描述#

接口功能:解绑 HTTP Service 域名

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

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

2. 输入参数#

字段必填类型说明
ActionString接口名称
ParamObject接口参数

Param 字段说明#

字段必填类型说明
ServiceIdStringService ID,该字段取值为环境 ID
DomainString绑定的域名

3. 返回结果#

字段必填类型说明
RequestIdString请求唯一标识
CountNumber解绑的 HTTP Service 域名个数

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: 'DeleteCloudBaseGWDomain',    Param: {      ServiceId: envId,      Domain: 'xxx.xxx.xxx'    }  })  console.log(res.Count)}
test()