如果你已创建应用,你可以控制该应用的启用/停用状态。你可以使用 ModifyAppStatus 这个 OpenAPI 实现这一功能。
你可以调用 ModifyAppStatus 这个 OpenAPI 修改 AppId 对应 App 的状态,状态分为启用和停用两种。
不论当前 AppID 是启用 or 停用状态,都会显示在控制台上。
关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法。
请求频率:QPS 不得超过 20。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ModifyAppStatus | 接口名称。当前 API 的名称为 ModifyAppStatus。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AppId | String | 是 | Your_AppId | 需要停用/启用的 AppId |
Status | Integer | 是 | 1 |
|
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 success,失败时为空。
POST https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2023-11-01
{
"AppId": "Your_AppId",
"Status": "Your_AppStatus"
}
json{
"ResponseMetadata": {
"RequestId": "2021081717484101022524310002120A9F",
"Action": "ModifyAppStatus",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": "success"
}
json您可访问公共错误码,获取更多错误码信息。