GetProvisionedProduct - Service Catalog - Alibaba Cloud Documentation Center

Queries the information about a product instance.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
servicecatalog:GetProvisionedProduct	get	*ProvisionedProduct `acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}`	servicecatalog:UserLevel servicecatalog:ApprovalActor	none

Request parameters

Parameter	Type	Required	Description	Example
ProvisionedProductId	string	Yes	The ID of the product instance.	pp-bp1ddg1n2a****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProvisionedProductDetail	object	The details of the product instance.
ProvisionedProductId	string	The ID of the product instance.	pp-bp1ddg1n2a****
ProvisionedProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product instance.	acs:servicecatalog:cn-hangzhou:146611588617**:provisionedproduct/pp-bp1ddg1n2a**
ProvisionedProductName	string	The name of the product instance.	DEMO-ECS instance
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-Create an ECS instance
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProductVersionName	string	The name of the product version.	1.0
LastTaskId	string	The ID of the task that was last run.	task-bp1dmg242c****
LastProvisioningTaskId	string	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****
LastSuccessfulProvisioningTaskId	string	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****
OwnerPrincipalType	string	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
OwnerPrincipalId	string	The ID of the RAM entity to which the product instance belongs.	24477111603637****
Status	string	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
StatusMessage	string	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...
CreateTime	string	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
PortfolioId	string	The ID of the product portfolio.	port-bp1yt7582g****
StackId	string	The ID of the Resource Orchestration Service (ROS) stack.	137e31df-3754-40b4-be2f-c793ad84****
StackRegionId	string	The ID of the region to which the ROS stack belongs.	cn-hangzhou
ProvisionedProductType	string	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,
    "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 code	Error code	Error message
500	InternalError	A system error occurred.

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