調用ListApplication擷取應用列表-雲速搭-阿里雲 - Cloud Architect Design Tools

該介面提供目前使用者下所有應用的列表。其中選擇性參數keyword定義應用程式名稱中包含的關鍵字。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

bpstudio:ListApplication

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

無

請求參數

名稱	類型	必填	描述	樣本值
NextToken	integer	是	結果值的分頁頁碼不能小於最小值 1，不能大於最大值 10000。	1
MaxResults	integer	是	結果值的分頁大小不能小於最小值 1，也不能大於最大值 50。	10
Keyword	string	否	應用程式名稱中的關鍵字	test
OrderType	integer	否	1 更新時間 2 建立時間	1
Status	string	否	應用的狀態。	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
ShowHide	boolean	否	是否顯示隱藏方案,預設為 true,true 顯示,false 不顯示	true

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	返回的條目總數。	123
Message	string	介面返回資訊。	Success
NextToken	integer	返回的當前頁碼。	2
RequestId	string	應用的 ID。	BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C
Data	array<object>	應用列表資訊
	object
ImageURL	string	應用 Topo 圖的 URL。	https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png
Status	string	應用狀態	Deployed_Success
ApplicationId	string	應用的名稱。	JIX9NEZUALGS46UI
Name	string	The name of the application.	cadt-appName
CreateTime	string	建立應用的時間。	2021-09-15 08:30:00
ResourceGroupId	string	應用所屬的資源群組的 ID。	default
Code	string	HTTP 狀態碼。	200

應用狀態列表：

Creating 建立中
Modified 已修改
Verifying 校正中
Verified_Failure 校正失敗
Verified_Success 校正成功
Valuating 計價中
Valuating_Failure 計價失敗
Valuating_Success 計價成功
Deploying 部署中
Deployed_Failure 部署失敗
Partially_Deployed_Success 部分部署成功
Deployed_Success 部署成功
Destroying 釋放中
Delayed_Destroy 延時銷毀
Destroyed_Failure 釋放失敗
Partially_Destroyed_Success 部分釋放成功
Destroyed_Success 釋放成功
Revised 架構調整
Verifying_In_Revision 資源驗證（架構調整）
Verified_Failure_In_Revision 資源驗證失敗（架構調整）
Verified_Success_In_Revision 資源驗證成功（架構調整）
Valuating_In_Revision 詢價中（架構調整）
Valuating_Failure_In_Revision 詢價失敗（架構調整）
Valuating_Success_In_Revision 詢價成功（架構調整）

樣本

正常返回樣本

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.	您必須指定請求參數。
500	ServiceError	A server error occurred. Please try again later.	伺服器異常，請稍後再試
404	EntityNotExist.ResourceGroup	The resource group does not exist.	資源群組不存在
404	EntityNotExist.ResourceId	The resource does not exist.	資源不存在

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。