文档首页/ 实时音视频 SparkRTC/ API参考/ 应用管理/ 停用应用
更新时间：2024-10-18 GMT+08:00
查看PDF
分享

停用应用

功能介绍

调用此接口停用单个应用。

应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。

URI

POST /v2/apps/{app_id}/disable

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

应用id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

内容类型。

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。
表4 响应Body参数

参数

参数类型

描述

app_id

String

应用id

state

AppState object

应用状态
表5 AppState

参数

参数类型

描述

state

String

状态

  • ACTIVATION：开启

  • DEACTIVATION：停用

  • ARREARS：欠费

  • DELETED：已删除

update_time

String

app鉴权的更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC

状态码： 404

表6 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。
表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。
表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

停用指定应用id的应用

POST https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/disable

响应示例

状态码： 200

停用成功

{
  "app_id" : "123456789abcdefghijklmno",
  "state" : {
    "state" : "DEACTIVATION",
    "update_time" : "2020-07-26T07:03:05.075Z"
  }
}

状态码： 404

app编号不存在

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

状态码： 500

设置失败，服务器端错误

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

状态码

状态码

描述

200

停用成功

404

app编号不存在

500

设置失败，服务器端错误

错误码

请参见错误码。

父主题： 应用管理