如果你已创建应用,你可以控制该应用的启用/停用状态。你可以使用 ModifyAppStatus 这个 OpenAPI 实现这一功能。

使用说明
接口行为

你可以调用 ModifyAppStatus 这个 OpenAPI 修改 AppId 对应 App 的状态,状态分为启用和停用两种。

不论当前 AppID 是启用 or 停用状态,都会显示在控制台上。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

注意事项

请求频率:QPS 不得超过 20。

请求说明
请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query
参数类型是否必选示例值描述
ActionString是ModifyAppStatus接口名称。当前 API 的名称为 ModifyAppStatus。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。
Body
参数类型是否必选示例值描述
AppIdString是Your_AppId需要停用/启用的 AppId

Status

Integer

是

1

  • 1:将 App 状态设置为启用;
  • 2:将 App 状态设置为停用;
返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 success,失败时为空。

请求示例
POST https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2020-12-01
{
    "AppId": "Your_AppId",
    "Status": "Your_AppStatus"
}
json
返回示例
{
  "ResponseMetadata": {
    "RequestId": "2021081717484101022524310002120A9F",
    "Action": "ModifyAppStatus",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": "success"
}
json
错误码

您可访问公共错误码,获取更多错误码信息。