Query plan details using GetProvisionedProductPlan - Service Catalog

Queries a provisioned product plan.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicecatalog:GetProvisionedProductPlan

get

*ProvisionedProduct

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

servicecatalog:UserLevel
servicecatalog:ApprovalActor

None

Request parameters

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

Response elements

Element	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	array<object>	An array that consists of the parameters in the template.
	object
ParameterKey	string	The name of the input parameter for the template.	instance_type
ParameterValue	string	The value of the input parameter for 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. ApplicationInProgress: The plan is being approved. ApplicationApproved: The plan is approved. ApplicationRejected: The approval is rejected. ExecuteInProgress: The plan is being run. ExecuteSuccess: The plan is run. ExecuteFailed: The plan fails to be run. Canceled: The plan is canceled.	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	array<object>	An array that consists of custom tags.
	object
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 ECS.
AssignedApprovers	array<object>	An array that consists of reviewers.
	object
PrincipalType	string	The type of the Resource Access Management (RAM) entity of the plan approver. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalName	string	The name of the RAM entity of the plan approver.	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 approval details of the plan.
OperationRecords	array<object>	The operation records.
	array<object>
Operator	object	The RAM entities that have performed operations on the plan.
PrincipalType	string	The type of the RAM entity. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalId	string	The ID of the RAM entity.	277401963826235***
PrincipalName	string	The name RAM entity that servers as the operator.	approver
Comment	string	The approval comment of the operator.	Approved.
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: rejectes the plan.	Approve
TodoTaskActivities	array<object>	The operations that are being performed by the plan.
	array<object>
ActivityName	string	The name of the operation that is being performed by the plan.	ApproverNode-1
Tasks	array<object>	The tasks that are pending for review.
	array<object>
Operator	object	The RAM entities that can perform operations on the plan.
PrincipalType	string	The type of the RAM entity. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalName	string	The name of the RAM entity.	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 ECS
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	array<object>	An array that consists of the resources to be changed in the plan.
	object
LogicalResourceId	string	The logical ID of the resource.	instance
PhysicalResourceId	string	The physical ID of the resource. Note This parameter is returned if the value of Action is 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 if the value of Action is Modify.	True
ResourceType	string	The resource type.	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.	This is a product version description
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

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.