# 查询应用列表 - ListApps #### 功能介绍 调用此接口查询应用列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudRTC/doc?api=ListApps)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rtc/rtc_07_0022.html)。 #### URI GET /v2/apps 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | state | 否 | String | 应用的状态： - ACTIVATION：应用开启 - DEACTIVATION：应用停用 - ARREARS：应用欠费 | | offset | 否 | Integer | 查询结果起始编号，此处代表分页的页码，默认为0。 | | limit | 否 | Integer | 查询结果集数量，此处代表每一页的条数，最小为1，最大为100。默认为100。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 内容类型。取值application/json。 | | 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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | app的总数 | | apps | Array of [App] objects | app的列表 | 表5App | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_name | String | app名称 | | app_id | String | 应用id | | state | [AppState] object | app状态 | | scope | String | RTC覆盖范围。 取值如下： - DOMESTIC：国内范围。 - OVERSEA：海外范围。 - GLOBAL：全球范围。 | | tenant_name | String | 账号名 | | domain | String | 域名，App对应域名 | | create_time | String | 创建时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC | | authentication | [AppAuth] object | 鉴权配置 | | callbacks | [AppCallbacks] object | 回调配置 | | auto_record_mode | [AppAutoRecordMode] object | 自动录制配置 | 表6AppState | 参数 | 参数类型 | 描述 | |:---|:---|:---| | state | String | 状态 - ACTIVATION：开启 - DEACTIVATION：停用 - ARREARS：欠费 - DELETED：已删除 | | update_time | String | app鉴权的更新时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC | 表7AppAuth | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enable | Boolean | 开启或关闭URL鉴权 | | expire | Integer | 接入RTC建链认证时的signature的有效期。单位：秒。默认300秒。signature由app_key生成 | | app_key | String | APP鉴权密钥 | | update_time | String | app鉴权的更新时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC | 表8AppCallbacks | 参数 | 参数类型 | 描述 | |:---|:---|:---| | push_callback | [AppCallbackUrl] object | 转推回调 | | record_callback | [AppCallbackUrl] object | 录制回调 | 表9AppCallbackUrl | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | 回调通知url地址，url必须以http://或https://开头，需要支持POST调用。 | | auth_key | String | 回调密钥，主要用于鉴权。如果不设置或者为空，则回调不会增加鉴权头域字段。 | | notify_event_subscription | Array of strings | 订阅云端录制通知消息。 取值如下： - RECORD_NEW_FILE_START：开始创建新的录制文件。 - RECORD_FILE_COMPLETE：录制文件生成完成。 | | update_time | String | 更新时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC。 | 表10AppAutoRecordMode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mode | String | 录制模式。 - AUTO_RECORD_OFF：关闭自动录制。 - AUTO_INDIVIDUAL_RECORD：开启单流自动录制，此时record_rule_id必须非空。 | | record_rule_id | String | 录制规则id。 | | update_time | String | 更新时间，形如"2006-01-02T15:04:05.075Z"，时区为：UTC。 | **状态码：400** 表11响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表13响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 | 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 查询当前租户下的全量应用 ``` GET https://rtc-api.myhuaweicloud.com/v2/apps ``` #### 响应示例 **状态码：200** 查询应用列表 ``` { "count" : 1, "apps" : [ { "app_name" : "example", "app_id" : "123456789abcdefghijklmno", "state" : { "state" : "ACTIVATION", "update_time" : "2020-07-26T07:03:05.075Z" }, "scope" : "DOMESTIC", "tenant_name" : "hwstaff_pub_videortc", "domain" : "123456789abcdefghijklmno.rtc.huawei.com", "create_time" : "2020-07-26T07:03:05.075Z", "authentication" : { "enable" : true, "expire" : 300, "app_key" : "12345ABCDEF12345", "update_time" : "2020-07-26T07:03:05.075Z" }, "callbacks" : { "push_callback" : { "url" : "", "auth_key" : "", "update_time" : "" }, "record_callback" : { "url" : "http://mydomain.com", "auth_key" : "78912374ae8cdb38", "update_time" : "2020-07-26T07:53:05.075Z" } }, "auto_record_mode" : { "mode" : "AUTO_RECORD_OFF", "update_time" : "2020-07-26T07:53:05.075Z" } } ] } ``` **状态码：400** 语义有误，当前请求无法被服务器理解，或参数有误 ``` { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue" } ``` **状态码：500** 查询出错，服务器端错误 ``` { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询应用列表 | | 400 | 语义有误，当前请求无法被服务器理解，或参数有误 | | 500 | 查询出错，服务器端错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rtc/ErrorCode.html)。