該接口提供當(dāng)前用戶下所有應(yīng)用的列表。其中可選參數(shù)keyword定義應(yīng)用名中包含的關(guān)鍵字。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| bpstudio:ListApplication | get |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NextToken | integer | 是 | 結(jié)果值的分頁頁碼不能小于最小值 1，不能大于最大值 10000。 | 1 |
| MaxResults | integer | 是 | 結(jié)果值的分頁大小不能小于最小值 1，也不能大于最大值 50。 | 10 |
| Keyword | string | 否 | 應(yīng)用名稱中的關(guān)鍵字 | test |
| OrderType | long | 否 | 1 更新時間 | 1 |
| Status | string | 否 | 應(yīng)用的狀態(tài)。 | 該參數(shù)可選值有“success”和“release”。 如果輸入值是“success”，返回的應(yīng)用列表包括所有部署成功（Deployed_Success）狀態(tài)的應(yīng)用； 如果輸入值是“release”，返回的應(yīng)用列表包括所有釋放成功（Destroyed_Success）和釋放失敗（Destroyed_Failure）狀態(tài)的應(yīng)用； 如果置空該參數(shù)，返回的應(yīng)用列表包括所有狀態(tài)的應(yīng)用。If the input value is "success", the returned application list includes all applications in the Deployed_Success state of successful deployment. If the input value is release, the returned application list includes all applications in the release success (Destroyed_Success) and release failure (Destroyed_Failure) status. If this parameter is left blank, the returned app list includes apps in all states. |
| ResourceGroupId | string | 否 | 資源組的 ID。 | default |
| ResourceId | string | 否 | 資源 ID | vsw-xxxxxxxxxxxx |
| TemplateId | string | 否 | 模板 ID | 0KSXXX6SJU03TXXX |
返回參數(shù)
應(yīng)用狀態(tài)列表：
Creating 創(chuàng)建中
Modified 已修改
Verifying 校驗(yàn)中
Verified_Failure 校驗(yàn)失敗
Verified_Success 校驗(yàn)成功
Valuating 計價中
Valuating_Failure 計價失敗
Valuating_Success 計價成功
Deploying 部署中
Deployed_Failure 部署失敗
Partially_Deployed_Success 部分部署成功
Deployed_Success 部署成功
Destroying 釋放中
Delayed_Destroy 延時銷毀
Destroyed_Failure 釋放失敗
Partially_Destroyed_Success 部分釋放成功
Destroyed_Success 釋放成功
Revised 架構(gòu)調(diào)整
Verifying_In_Revision 資源驗(yàn)證（架構(gòu)調(diào)整）
Verified_Failure_In_Revision 資源驗(yàn)證失敗（架構(gòu)調(diào)整）
Verified_Success_In_Revision 資源驗(yàn)證成功（架構(gòu)調(diào)整）
Valuating_In_Revision 詢價中（架構(gòu)調(diào)整）
Valuating_Failure_In_Revision 詢價失敗（架構(gòu)調(diào)整）
Valuating_Success_In_Revision 詢價成功（架構(gòu)調(diào)整）
示例
正常返回示例
JSON格式
{
"TotalCount": 123,
"Message": "Success",
"NextToken": 2,
"RequestId": "BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C",
"Data": [
{
"ImageURL": "https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png",
"Status": "Deployed_Success",
"ApplicationId": "JIX9NEZUALGS46UI",
"Name": "cadt-appName",
"CreateTime": "2021-09-15 08:30:00",
"ResourceGroupId": "default"
}
],
"Code": 200
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 200 | Success | The transaction is successful. | 交易成功 |
| 400 | ParameterEmpty | You must specify the request parameter. | 您必須指定請求參數(shù)。 |
| 404 | EntityNotExist.ResourceGroup | The resource group does not exist. | 資源組不存在 |
| 404 | EntityNotExist.ResourceId | The resource does not exist. | 資源不存在 |
| 500 | ServiceError | A server error occurred. Please try again later. | 服務(wù)器異常，請稍后再試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-01-25 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-05-25 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-03-14 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2022-09-29 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |