All Products
Search
Document Center

Service Catalog:GetProvisionedProduct

Last Updated:Mar 03, 2024

Queries the information about a product instance.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProvisionedProductIdstringYes

The ID of the product instance.

pp-bp1ddg1n2a****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The details of the product instance.

ProvisionedProductIdstring

The ID of the product instance.

pp-bp1ddg1n2a****
ProvisionedProductArnstring

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

acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****
ProvisionedProductNamestring

The name of the product instance.

DEMO-ECS instance
ProductIdstring

The ID of the product.

prod-bp18r7q127****
ProductNamestring

The name of the product.

DEMO-Create an ECS instance
ProductVersionIdstring

The ID of the product version.

pv-bp15e79d26****
ProductVersionNamestring

The name of the product version.

1.0
LastTaskIdstring

The ID of the task that was last run.

task-bp1dmg242c****
LastProvisioningTaskIdstring

The ID of the task that was last run on the product instance.

The task can be one of the following types:

  • LaunchProduct: a task that launches the product.
  • UpdateProvisionedProduct: a task that updates the information about the product instance.
  • TerminateProvisionedProduct: a task that terminates the product instance.
task-bp1dmg242c****
LastSuccessfulProvisioningTaskIdstring

The ID of the last task that was successfully run on the product instance.

The task can be one of the following types:

  • LaunchProduct: a task that launches the product.
  • UpdateProvisionedProduct: a task that updates the information about the product instance.
  • TerminateProvisionedProduct: a task that terminates the product instance.
task-bp1dmg242c****
OwnerPrincipalTypestring

The type of the Resource Access Management (RAM) entity to which the product instance belongs. Valid values:

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

The ID of the RAM entity to which the product instance belongs.

24477111603637****
Statusstring

The state of the product instance. Valid values:

  • Available: The product instance was available.
  • UnderChange: The information about the product instance was being changed.
  • Error: An exception occurred on the product instance.
Available
StatusMessagestring

The message that is returned for the status of the product instance.

Note This parameter is returned only when Error is returned for the Status parameter.
Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
CreateTimestring

The time when the product instance 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
PortfolioIdstring

The ID of the product portfolio.

port-bp1yt7582g****
StackIdstring

The ID of the Resource Orchestration Service (ROS) stack.

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

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

cn-hangzhou
ProvisionedProductTypestring

The type of the product instance.

The value is fixed as RosStack, which indicates an ROS stack.

RosStack

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProvisionedProductDetail": {
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS instance\n",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create an ECS instance\n",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0",
    "LastTaskId": "task-bp1dmg242c****",
    "LastProvisioningTaskId": "task-bp1dmg242c****",
    "LastSuccessfulProvisioningTaskId": "task-bp1dmg242c****",
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "24477111603637****",
    "Status": "Available",
    "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
    "CreateTime": "2022-05-23T09:46:27Z",
    "PortfolioId": "port-bp1yt7582g****",
    "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
    "StackRegionId": "cn-hangzhou",
    "ProvisionedProductType": "RosStack"
  }
}

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

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