All Products
Search
Document Center

Service Catalog:GetProvisionedProductPlan

Last Updated:Jul 25, 2025

Queries the details of a plan.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
servicecatalog:GetProvisionedProductPlanget
*ProvisionedProduct
acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}
  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor
none

Request parameters

ParameterTypeRequiredDescriptionExample
PlanIdstringYes

The ID of the plan.

plan-bp1jvmdk2k****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanDetailobject

The details of the plan.

PlanIdstring

The ID of the plan.

plan-bp1jvmdk2k****
PlanNamestring

The name of the plan.

DEMO-ECS instance
PlanTypestring

The type of the plan.

The value is fixed as Ros, which indicates Resource Orchestration Service (ROS).

Ros
PortfolioIdstring

The ID of the product portfolio.

port-bp1yt7582g****
ProductIdstring

The ID of the product.

prod-bp18r7q127****
ProductVersionIdstring

The ID of the product version.

pv-bp15e79d26****
ProvisionedProductIdstring

The ID of the product instance.

pp-bp1ddg1n2a****
ProvisionedProductNamestring

The name of the product instance.

DEMO-ECS instance
Parametersarray<object>

An array that consists of the parameters in the template.

Parameterobject
ParameterKeystring

The name of the input parameter for the template.

instance_type
ParameterValuestring

The value of the input parameter for the template.

ecs.s6-c1m1.small
StackIdstring

The ID of the ROS stack.

137e31df-3754-40b4-be2f-c793ad84****
StackRegionIdstring

The ID of the region to which the ROS stack belongs.

cn-hangzhou
Statusstring

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
StatusMessagestring

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...
CreateTimestring

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
UpdateTimestring

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
Tagsarray<object>

An array that consists of custom tags.

Tagobject
Keystring

The key of the custom tag.

k1
Valuestring

The value of the custom tag.

v1
OperationTypestring

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
Descriptionstring

The description of the plan.

Create an ECS instance.
AssignedApproversarray<object>

An array that consists of reviewers.

AssignedApproverobject
PrincipalTypestring

The type of the Resource Access Management (RAM) entity of the plan approver. Valid values:

  • RamUser: a RAM user.
  • RamRole: a RAM role.
RamUser
PrincipalNamestring

The name of the RAM entity of the plan approver.

approver
OwnerPrincipalTypestring

The type of the RAM entity to which the plan belongs. Valid values:

  • RamUser: a RAM user
  • RamRole: a RAM role
RamUser
OwnerPrincipalIdstring

The ID of the RAM entity to which the plan belongs.

27740196382623****
ApprovalDetailobject

The approval details of the plan.

OperationRecordsarray<object>

The operation records.

OperationRecordobject
Operatorobject

The RAM entities that have performed operations on the plan.

PrincipalTypestring

The type of the RAM entity. Valid values:

  • RamUser: a RAM user.
  • RamRole: a RAM role.
RamUser
PrincipalIdstring

The ID of the RAM entity.

277401963826235***
PrincipalNamestring

The name RAM entity that servers as the operator.

approver
Commentstring

The approval comment of the operator.

Agreed.
CreateTimestring

The time when the operation was performed.

2022-03-22T05:56:14Z
ApprovalActionstring

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
TodoTaskActivitiesarray<object>

The operations that are being performed by the plan.

TodoTaskActivitieobject
ActivityNamestring

The name of the operation that is being performed by the plan.

ApproverNode-1
Tasksarray<object>

The tasks that are pending for review.

Taskobject
Operatorobject

The RAM entities that can perform operations on the plan.

PrincipalTypestring

The type of the RAM entity. Valid values:

  • RamUser: a RAM user.
  • RamRole: a RAM role.
RamUser
PrincipalNamestring

The name of the RAM entity.

approver
OwnerPrincipalNamestring

The name of the RAM entity to which the plan belongs.

endUser
Uidstring

The ID of the Alibaba Cloud account to which the plan belongs.

146611588617****
ProductDetailobject

The details of the product.

ProductArnstring

The Alibaba Cloud Resource Name (ARN) of the product.

acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****
Descriptionstring

The description of the product.

This is a product description.
CreateTimestring

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
ProductIdstring

The ID of the product.

prod-bp18r7q127****
ProductNamestring

The name of the product.

DEMO-Create an ECS instance
ProviderNamestring

The provider of the product.

IT team
ProductTypestring

The type of the product.

The value is fixed as Ros, which indicates ROS.

Ros
ResourceChangesarray<object>

An array that consists of the resources to be changed in the plan.

ResourceChangeobject
LogicalResourceIdstring

The logical ID of the resource.

instance
PhysicalResourceIdstring

The physical ID of the resource.

Note This parameter is returned if the value of Action is Modify or Remove.
i-bp13lmam3qd9q6il****
Replacementstring

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
ResourceTypestring

The resource type.

alicloud_instance
Actionstring

The action that is performed on the resource. Valid values:

  • Add
  • Modify
  • Remove
  • None
Add
ProductVersionDetailobject

The details of the product version.

Activeboolean

Indicates whether the product version is visible to end users. Valid values:

  • true (default)
  • false
true
Descriptionstring

The description of the product version.

The description of the product version.
CreateTimestring

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
Guidancestring

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
ProductVersionIdstring

The ID of the product version.

pv-bp15e79d26****
ProductVersionNamestring

The name for the version of the product.

1.0.0
ProductIdstring

The ID of the product to which the product version belongs.

prod-bp18r7q127****
TemplateUrlstring

The URL of the template.

oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json
TemplateTypestring

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 codeError codeError message
500InternalErrorA system error occurred.

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