启用&停用应用 ModifyAppStatus--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

启用&停用应用 ModifyAppStatus

最近更新时间：2024.02.29 19:32:55首次发布时间：2021.09.10 09:58:01

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

使用说明

接口行为

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

启用：正常使用状态，为新创建 AppID 的默认状态。
停用：变更后的状态，只表示当前 AppID 功能不可用，即 RTC 的基础功能和增值功能都不可用，包括用户无法加入房间、云端媒体处理的功能无法开启等,但不影响控制台正常显示该 AppID 信息。

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

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

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=ModifyAppStatus&Version=2020-12-01

请求参数

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

Query

参数名称	数据类型	是否必选	示例值	描述
Action	String	是	`ModifyAppStatus`	接口名称。当前 API 的名称为 `ModifyAppStatus`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`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"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021081717484101022524310002120A9F",
    "Action": "ModifyAppStatus",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  },
  "Result": "success"
}

错误码

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