調用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 返回結構發生變更 | 查看變更詳情 |