ListProvisionedProductPlans查詢計劃列表API參考-服務類別目錄-阿里雲 - Service Catalog

查詢計劃列表。可分使用者維度和審批維度進行查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

servicecatalog:ListProvisionedProductPlans

list

*全部資源

*

servicecatalog:UserLevel
servicecatalog:ApprovalActor

無

請求參數

名稱	類型	必填	描述	樣本值
Filters	array<object>	否	過濾條件。
	object	否
Key	string	否	過濾條件的名稱。取值： ProvisionedProductPlanName：按計劃名稱尋找，完整匹配（忽略大小寫）。 ProvisionedProductPlanApprover：按審批人精確尋找，格式為`RamUser/RamRole:<審批人名稱>`，可多選。 ProvisionedProductPlanApproverName：按審批人名稱尋找，直接輸入審批人的 RAM 實體名稱，可多選。 ProvisionedProductPlanStatus：按計劃狀態尋找，直接輸入計劃狀態，可多選。 ProvisionedProductPlanOwnerUid：按計劃歸屬雲帳號 ID 精確尋找。 FullTextSearch：全文檢索索引，按計劃名稱尋找，模糊比對。	FullTextSearch
Value	string	否	過濾條件的值。	ECS
SortBy	string	否	排序欄位。取值為 CreateTime，表示計劃建立時間。	CreateTime
SortOrder	string	否	排序方式。取值： Asc：正序。 Desc（預設值）：倒序。枚舉值： Asc : Asc Desc : Desc	Desc
PageNumber	integer	否	頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁時每頁顯示的資料行數。取值範圍：1~100。起始值：1。預設值：10。	10
AccessLevelFilter	string	否	訪問過濾器。取值： User（預設值）：使用者。 Account：帳號。 ResourceDirectory：資來源目錄。	User
ApprovalFilter	string	否	審批維度訪問過濾器。取值： ReceivedRequests：待我審批。 ApprovalHistory：審批歷史。 AccountRequests：帳號層級全部審批。 ResourceDirectoryRequests：資來源目錄層級全部審批。	ReceivedRequests
ProvisionedProductId	string	否	執行個體 ID。	pp-bp1ddg1n2a****

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
RequestId	string	請求 ID。	0FEEF92D-4052-5202-87D0-3D8EC16F****
PlanDetails	array<object>	計劃列表。
	array<object>
PlanId	string	計劃 ID。	plan-bp18mmdh2u****
PlanName	string	計劃名稱。	DEMO-建立ECS-637****
PlanType	string	計劃類型。取值為 Ros，表示阿里雲Resource Orchestration Service服務（ROS）。	Ros
PortfolioId	string	產品組合 ID。	port-bp1438kf2j****
ProductId	string	產品識別碼。	prod-bp1rtrnh2c****
ProductVersionId	string	產品版本 ID。	pv-bp19udk22v****
ProvisionedProductId	string	執行個體 ID。	pp-bp1c35162d****
Parameters	array<object>	使用者輸入的模板參數。
	object
ParameterKey	string	模板中定義的參數名稱。	role_name
ParameterValue	string	使用者輸入的模板參數值。	Test-8
ProvisionedProductName	string	執行個體名稱。	rds-MYSQL-875****
StackId	string	阿里雲Resource Orchestration Service服務（ROS）資源棧 ID。	2599090a-309e-4306-b989-17ba66a9****
StackRegionId	string	阿里雲Resource Orchestration Service服務（ROS）資源棧所屬的地區 ID。	cn-hangzhou
Status	string	計劃狀態。取值： PreviewInProgress：預檢中。 PreviewSuccess：預檢成功。 PreviewFailed：預檢失敗。 ApplicationInProgress：審批中。 ApplicationApproved：審批通過。 ApplicationRejected：審批被拒絕。 ExecuteInProgress：執行中。 ExecuteSuccess：執行成功。 ExecuteFailed：執行失敗。 Canceled：已取消。	PreviewSuccess
StatusMessage	string	計劃狀態資訊。說明僅在計劃狀態為 PreviewFailed 或 ExecuteFailed 時，返回該參數。	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	計劃建立時間。按照 ISO8601 標準表示，使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ssZ。	2022-09-13T02:01:22Z
UpdateTime	string	計劃最後更新時間。按照 ISO8601 標準表示，使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ssZ。	2022-07-18T06:02:35.075Z
Tags	array<object>	使用者自訂標籤列表。
	object
Key	string	使用者自訂標籤鍵。	k1
Value	string	使用者自訂標籤值。	v1
OperationType	string	計劃操作類型。取值： LaunchProduct（預設）：啟動產品。 UpdateProvisionedProduct：更新執行個體。 TerminateProvisionedProduct：終止執行個體。	LaunchProduct
AssignedApprovers	array<object>	計劃審批人列表。
	object
PrincipalType	string	計劃審批人的 RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
PrincipalName	string	計劃審批人的 RAM 實體名稱。	endUser
ProductName	string	產品名稱。	建立ECS
Description	string	計劃描述。	Team Dev使用
OwnerPrincipalType	string	計劃歸屬人的 RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
OwnerPrincipalId	string	計劃歸屬人的 RAM 實體 ID。	24477111603637****
OwnerPrincipalName	string	計劃歸屬人的 RAM 實體名稱。	enduser
Uid	string	計劃歸屬人的雲帳號 ID。	146611588617****
TotalCount	integer	總記錄數。	16
PageNumber	integer	頁碼。起始值：1。預設值：1。	1
PageSize	integer	分頁時每頁顯示的資料行數。取值範圍：1~100。起始值：1。預設值：10。	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO-建立ECS-637****",
      "PlanType": "Ros",
      "PortfolioId": "port-bp1438kf2j****",
      "ProductId": "prod-bp1rtrnh2c****",
      "ProductVersionId": "pv-bp19udk22v****",
      "ProvisionedProductId": "pp-bp1c35162d****",
      "Parameters": [
        {
          "ParameterKey": "role_name",
          "ParameterValue": "Test-8"
        }
      ],
      "ProvisionedProductName": "rds-MYSQL-875****",
      "StackId": "2599090a-309e-4306-b989-17ba66a9****",
      "StackRegionId": "cn-hangzhou",
      "Status": "PreviewSuccess",
      "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-09-13T02:01:22Z",
      "UpdateTime": "2022-07-18T06:02:35.075Z",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "OperationType": "LaunchProduct",
      "AssignedApprovers": [
        {
          "PrincipalType": "RamUser",
          "PrincipalName": "endUser"
        }
      ],
      "ProductName": "建立ECS",
      "Description": "Team Dev使用",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "PageNumber": 1,
  "PageSize": 10
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	A system error occurred.	內部錯誤。

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

變更歷史

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