調(diào)用DescribeApps查詢應(yīng)用列表。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
rtc:DescribeApps | get | *全部資源 * |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 否 | 應(yīng)用 ID,通過控制臺(tái)創(chuàng)建和查詢,僅支持傳單個(gè) ID。 參數(shù)為空表示查詢所有應(yīng)用 ID。 | yourAppId |
Status | string | 否 | 應(yīng)用狀態(tài),參數(shù)為空表示查詢所有狀態(tài)。取值:
| 1 |
Order | string | 否 | 排序方式。取值:
| asc |
PageNum | integer | 否 | 第幾頁,默認(rèn)查詢第 1 頁。 | 1 |
PageSize | integer | 否 | 每頁顯示個(gè)數(shù),默認(rèn)為 10。 | 2 |
AppVersion | string | 否 | 應(yīng)用版本。 | 3.0 |
返回參數(shù)
示例
正常返回示例
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"
}
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
---|---|---|
404 | InvalidAppId.NotFound | %s |
500 | InternalError | %s |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-01-31 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-01-31 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |