GetProvisionedProductPlan - Service Catalog - Alibaba Cloud Documentation Center

Queries the details of a plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PlanId	string	Yes	The ID of the plan.	plan-bp1jvmdk2k****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanDetail	object	The details of the plan.
PlanId	string	The ID of the plan.	plan-bp1jvmdk2k****
PlanName	string	The name of the plan.	DEMO-ECS instance
PlanType	string	The type of the plan. The value is fixed as Ros, which indicates Resource Orchestration Service (ROS).	Ros
PortfolioId	string	The ID of the product portfolio.	port-bp1yt7582g****
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProvisionedProductId	string	The ID of the product instance.	pp-bp1ddg1n2a****
ProvisionedProductName	string	The name of the product instance.	DEMO-ECS instance
Parameters	object []	An array that consists of the parameters in the template.
ParameterKey	string	The name of the parameter in the template.	instance_type
ParameterValue	string	The value of the parameter in the template.	ecs.s6-c1m1.small
StackId	string	The ID of the ROS stack.	137e31df-3754-40b4-be2f-c793ad84****
StackRegionId	string	The ID of the region to which the ROS stack belongs.	cn-hangzhou
Status	string	The state of the plan. Valid values: PreviewInProgress: The plan is being prechecked. PreviewSuccess: The precheck is successful. PreviewFailed: The precheck fails. ExecuteInProgress: The plan is being run. ExecuteSuccess: The plan is run. ExecuteFailed: The plan fails to be run.	PreviewSuccess
StatusMessage	string	The message returned for the state. Note This parameter is returned only when PreviewFailed or ExecuteFailed is returned for Status.	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the plan was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-05-23T09:46:27Z
UpdateTime	string	The last time when the task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-05-23T09:47:29Z
Tags	object []	An array that consists of custom tags.
Key	string	The key of the custom tag.	k1
Value	string	The value of the custom tag.	v1
OperationType	string	The purpose of the plan. Valid values: LaunchProduct: launches the product. UpdateProvisionedProduct: updates the information about the product instance. TerminateProvisionedProduct: terminates the product instance.	LaunchProduct
Description	string	The description of the plan.	Create an ECS instance.
AssignedApprovers	object []	An array that consists of reviewers.
PrincipalType	string	The type of the Resource Access Management (RAM) entity of the reviewer. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalName	string	The RAM entity name of the reviewer.	approver
OwnerPrincipalType	string	The type of the RAM entity to which the plan belongs. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
OwnerPrincipalId	string	The ID of the RAM entity to which the plan belongs.	27740196382623****
ApprovalDetail	object	The review details of the plan.
OperationRecords	object []	An array that consists of operations that are performed by the operator.
Operator	object	The operator who performs operations on the plan.
PrincipalType	string	The RAM entity type of the operator. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalId	string	The RAM entity ID of the operator.	277401963826235***
PrincipalName	string	The RAM entity name of the operator.	approver
Comment	string	The review comment of the operator.	Agreed.
CreateTime	string	The time when the operation was performed.	2022-03-22T05:56:14Z
ApprovalAction	string	The operation that is performed by the operator on the plan. Valid values: Submit: submits the plan. Cancel: cancels the plan. Approve: approves the plan. reject: rejects the plan.	Approve
TodoTaskActivities	object []	An array that consists of operations that are being performed by the plan.
ActivityName	string	The name of the operation that is being performed by the plan.	ApproverNode-1
Tasks	object []	An array consisting of tasks that are pending for review.
Operator	object	The operator who performs operations on the plan.
PrincipalType	string	The RAM entity type of the operator. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalName	string	The RAM entity name of the operator.	approver
OwnerPrincipalName	string	The name of the RAM entity to which the plan belongs.	endUser
Uid	string	The ID of the Alibaba Cloud account to which the plan belongs.	146611588617****
ProductDetail	object	The details of the product.
ProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product.	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	The description of the product.	This is a product description.
CreateTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-04-12T06:10:37Z
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-Create an ECS instance
ProviderName	string	The provider of the product.	IT team
ProductType	string	The type of the product. The value is fixed as Ros, which indicates ROS.	Ros
ResourceChanges	object []	An array that consists of the resources to be changed in the plan.
LogicalResourceId	string	The logical ID of the resource.	instance
PhysicalResourceId	string	The physical ID of the resource. Note This parameter is returned only when Action is set to Modify or Remove.	i-bp13lmam3qd9q6il****
Replacement	string	Indicates whether a replacement update is performed on the template. Valid values: True: A replacement update is performed on the template. False: A change is made on the template. Conditional: A replacement update may be performed on the template. You can check whether a replacement update is performed when the template is in use. Note This parameter is returned only when Action is set to Modify.	True
ResourceType	string	The type of the resource.	alicloud_instance
Action	string	The action that is performed on the resource. Valid values: Add Modify Remove None	Add
ProductVersionDetail	object	The details of the product version.
Active	boolean	Indicates whether the product version is visible to end users. Valid values: true (default) false	true
Description	string	The description of the product version.	The description of the product version.
CreateTime	string	The time when the product version was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-04-12T06:10:37Z
Guidance	string	The recommendation information. Valid values: Default: No recommendation information is provided. This is the default value. Recommended: the recommendation version. Latest: the latest version. Deprecated: the version that is about to be deprecated.	Default
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProductVersionName	string	The name for the version of the product.	1.0.0
ProductId	string	The ID of the product to which the product version belongs.	prod-bp18r7q127****
TemplateUrl	string	The URL of the template.	oss://servicecatalog-cn-hangzhou/146611588617**/terraform/template/tpl-bp1217we23**/template.json
TemplateType	string	The type of the template. The value is fixed as RosTerraformTemplate, which indicates that the Terraform template is supported by ROS.	RosTerraformTemplate

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanDetail": {
    "PlanId": "plan-bp1jvmdk2k****",
    "PlanName": "DEMO-ECS instance\n",
    "PlanType": "Ros",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS instance\n",
    "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": "Create an ECS instance.\n",
    "AssignedApprovers": [
      {
        "PrincipalType": "RamUser",
        "PrincipalName": "approver"
      }
    ],
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "27740196382623****",
    "ApprovalDetail": {
      "OperationRecords": [
        {
          "Operator": {
            "PrincipalType": "RamUser",
            "PrincipalId": "277401963826235***\n",
            "PrincipalName": "approver"
          },
          "Comment": "Agreed.\n",
          "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": "This is a product description.\n",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create an ECS instance\n",
    "ProviderName": "IT team\n",
    "ProductType": "Ros"
  },
  "ResourceChanges": [
    {
      "LogicalResourceId": "instance",
      "PhysicalResourceId": "i-bp13lmam3qd9q6il****",
      "Replacement": "True",
      "ResourceType": "alicloud_instance\n",
      "Action": "Add"
    }
  ],
  "ProductVersionDetail": {
    "Active": true,
    "Description": "The description of the product version.\n",
    "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"
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	A system error occurred.

For a list of error codes, visit the Service error codes.