調用GetProvisionedProductPlan API查詢計劃資訊-服務類別目錄-阿里雲 - Service Catalog

查詢計劃資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

servicecatalog:GetProvisionedProductPlan

get

*ProvisionedProduct

acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}

servicecatalog:UserLevel
servicecatalog:ApprovalActor

無

請求參數

名稱	類型	必填	描述	樣本值
PlanId	string	是	計劃 ID。	plan-bp1jvmdk2k****

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
RequestId	string	請求 ID。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanDetail	object	計劃詳情。
PlanId	string	計劃 ID。	plan-bp1jvmdk2k****
PlanName	string	計劃名稱。	DEMO-ECS執行個體
PlanType	string	計劃類型。取值為 Ros，表示阿里雲Resource Orchestration Service服務（ROS）。	Ros
PortfolioId	string	產品組合 ID。	port-bp1yt7582g****
ProductId	string	產品識別碼。	prod-bp18r7q127****
ProductVersionId	string	產品版本 ID。	pv-bp15e79d26****
ProvisionedProductId	string	執行個體 ID。	pp-bp1ddg1n2a****
ProvisionedProductName	string	執行個體名稱。	DEMO-ECS執行個體
Parameters	array<object>	使用者輸入的模板參數。
	object
ParameterKey	string	模板中定義的參數名稱。	instance_type
ParameterValue	string	使用者輸入的模板參數值。	ecs.s6-c1m1.small
StackId	string	阿里雲Resource Orchestration Service服務（ROS）資源棧 ID。	137e31df-3754-40b4-be2f-c793ad84****
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-05-23T09:46:27Z
UpdateTime	string	計劃最後更新時間。按照 ISO8601 標準表示，使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ssZ。	2022-05-23T09:47:29Z
Tags	array<object>	使用者自訂標籤列表。
	object
Key	string	使用者自訂標籤鍵。	k1
Value	string	使用者自訂標籤值。	v1
OperationType	string	計劃操作類型。取值： LaunchProduct：啟動產品。 UpdateProvisionedProduct：更新執行個體。 TerminateProvisionedProduct：終止執行個體。	LaunchProduct
Description	string	計劃描述。	建立ECS。
AssignedApprovers	array<object>	計劃審批人列表。
	object
PrincipalType	string	計劃審批人的 RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
PrincipalName	string	計劃審批人的 RAM 實體名稱。	approver
OwnerPrincipalType	string	計劃歸屬人的 RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
OwnerPrincipalId	string	計劃歸屬人的 RAM 實體 ID。	27740196382623****
ApprovalDetail	object	計劃審批詳情。
OperationRecords	array<object>	操作記錄。
	array<object>
Operator	object	已對計划進行操作的 RAM 實體。
PrincipalType	string	RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
PrincipalId	string	RAM 實體 ID。	277401963826235***
PrincipalName	string	操作人的 RAM 實體名稱。	approver
Comment	string	操作人的審批附加意見。	同意。
CreateTime	string	操作時間。	2022-03-22T05:56:14Z
ApprovalAction	string	操作人對計划進行的操作類型。取值： Submit：提交計劃。 Cancel：取消計劃。 Approve：審批通過。 Reject：審批拒絕。	Approve
TodoTaskActivities	array<object>	計劃正在執行的操作。
	array<object>
ActivityName	string	計劃正在執行的操作名。	ApproverNode-1
Tasks	array<object>	委派工作清單。
	array<object>
Operator	object	可對計划進行操作的 RAM 實體。
PrincipalType	string	RAM 實體類型。取值： RamUser：RAM 使用者。 RamRole：RAM 角色。	RamUser
PrincipalName	string	RAM 實體名稱。	approver
OwnerPrincipalName	string	計劃歸屬人的 RAM 實體名稱。	endUser
Uid	string	計劃歸屬人的雲帳號 ID。	146611588617****
ProductDetail	object	計劃產品詳情。
ProductArn	string	產品 ARN。	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	產品描述。	這是一個產品描述
CreateTime	string	建立時間。按照 ISO8601 標準表示，使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ssZ。	2022-04-12T06:10:37Z
ProductId	string	產品識別碼。	prod-bp18r7q127****
ProductName	string	產品名稱。	DEMO-建立ECS
ProviderName	string	產品提供者。	IT團隊
ProductType	string	產品類型。取值為 Ros，表示阿里雲Resource Orchestration Service服務（ROS）。	Ros
ResourceChanges	array<object>	計劃資源變更列表。
	object
LogicalResourceId	string	資源邏輯 ID。	instance
PhysicalResourceId	string	資源物理 ID。說明當 Action 為 Modify 或 Remove 時，返回本參數。	i-bp13lmam3qd9q6il****
Replacement	string	模板是否為替換更新。取值： True：替換更新。 False：修改更新。 Conditional：可能是替換更新，模板運行時才能確定。說明當 Action 為 Modify 時，返回本參數。	True
ResourceType	string	資源類型。	alicloud_instance
Action	string	資源行為。取值： Add：增加資源。 Modify：修改資源。 Remove：刪除資源。 None：無變化。	Add
ProductVersionDetail	object	產品版本詳情。
Active	boolean	是否啟用。取值： true（預設值）：啟用。 false：禁用。	true
Description	string	產品版本描述。	這是一個產品版本描述
CreateTime	string	產品版本建立時間。按照 ISO8601 標準表示，使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ssZ。	2022-04-12T06:10:37Z
Guidance	string	推薦資訊。取值： Default（預設值）：無。 Recommended：穩定版。 Latest：最新版。 Deprecated：將廢棄。	Default
ProductVersionId	string	產品版本 ID。	pv-bp15e79d26****
ProductVersionName	string	產品版本名稱。	1.0.0
ProductId	string	產品版本所屬的產品識別碼。	prod-bp18r7q127****
TemplateUrl	string	模板的 URL 地址。	oss://servicecatalog-cn-hangzhou/146611588617**/terraform/template/tpl-bp1217we23**/template.json
TemplateType	string	模板類型。取值為 RosTerraformTemplate，表示阿里雲Resource Orchestration Service服務（ROS）支援的 Terraform 模板。	RosTerraformTemplate

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanDetail": {
    "PlanId": "plan-bp1jvmdk2k****",
    "PlanName": "DEMO-ECS執行個體",
    "PlanType": "Ros",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS執行個體",
    "Parameters": [
      {
        "ParameterKey": "instance_type",
        "ParameterValue": "ecs.s6-c1m1.small"
      }
    ],
    "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
    "StackRegionId": "cn-hangzhou",
    "Status": "PreviewSuccess",
    "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
    "CreateTime": "2022-05-23T09:46:27Z",
    "UpdateTime": "2022-05-23T09:47:29Z",
    "Tags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ],
    "OperationType": "LaunchProduct",
    "Description": "建立ECS。",
    "AssignedApprovers": [
      {
        "PrincipalType": "RamUser",
        "PrincipalName": "approver"
      }
    ],
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "27740196382623****",
    "ApprovalDetail": {
      "OperationRecords": [
        {
          "Operator": {
            "PrincipalType": "RamUser",
            "PrincipalId": "277401963826235***\n",
            "PrincipalName": "approver"
          },
          "Comment": "同意。",
          "CreateTime": "2022-03-22T05:56:14Z",
          "ApprovalAction": "Approve"
        }
      ],
      "TodoTaskActivities": [
        {
          "ActivityName": "ApproverNode-1",
          "Tasks": [
            {
              "Operator": {
                "PrincipalType": "RamUser",
                "PrincipalName": "approver"
              }
            }
          ]
        }
      ]
    },
    "OwnerPrincipalName": "endUser",
    "Uid": "146611588617****"
  },
  "ProductDetail": {
    "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
    "Description": "這是一個產品描述",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-建立ECS",
    "ProviderName": "IT團隊",
    "ProductType": "Ros"
  },
  "ResourceChanges": [
    {
      "LogicalResourceId": "instance",
      "PhysicalResourceId": "i-bp13lmam3qd9q6il****",
      "Replacement": "True",
      "ResourceType": "alicloud_instance\n",
      "Action": "Add"
    }
  ],
  "ProductVersionDetail": {
    "Active": true,
    "Description": "這是一個產品版本描述",
    "CreateTime": "2022-04-12T06:10:37Z",
    "Guidance": "Default",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0.0",
    "ProductId": "prod-bp18r7q127****",
    "TemplateUrl": "oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json",
    "TemplateType": "RosTerraformTemplate"
  }
}

錯誤碼

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

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

變更歷史

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