调用DescribeApps查询应用列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:DescribeApps | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 否 | 应用 ID，通过控制台创建和查询，仅支持传单个 ID。 参数为空表示查询所有应用 ID。 | yourAppId |
| Status | string | 否 | 应用状态，参数为空表示查询所有状态。取值：
| 1 |
| Order | string | 否 | 排序方式。取值：
| asc |
| PageNum | integer | 否 | 第几页，默认查询第 1 页。 | 1 |
| PageSize | integer | 否 | 每页显示个数，默认为 10。 | 2 |
| AppVersion | string | 否 | 应用版本。 | 3.0 |
返回参数
示例
正常返回示例
JSON格式
{
"TotalPage": 1,
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C6",
"TotalNum": 1,
"AppList": {
"App": [
{
"Status": 1,
"AppName": "Default AppName",
"AppId": "rgf1****\"",
"CreateTime": "2020-01-09T02:02:29Z",
"BillType": "PayByCR",
"AppType": "universal",
"ServiceAreas": {
"ServiceArea": [
"CN"
]
},
"Version": "3.0"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 404 | InvalidAppId.NotFound | %s |
| 500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-22 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-01-31 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-01-31 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |