All Products
Search
Document Center

Service Catalog:GetProductVersion

Last Updated:Jul 25, 2025

Queries the details of a product version.

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:GetProductVersionget
*Product
acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductVersionIdstringYes

The ID of the product version.

pv-bp15e79d26****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ProductVersionDetailobject

The details of the product version.

Activeboolean

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

  • true: The product version is visible to end users. This is the default value.
  • false: The product version is invisible to end users.
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 of the product version.

1.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 product template. Valid values:

  • RosTerraformTemplate: The Terraform template that is supported by Resource Orchestration Service (ROS).
  • RosStandardTemplate: The standard ROS template.
RosTerraformTemplate
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "ProductVersionDetail": {
    "Active": true,
    "Description": "The description of the product version.",
    "CreateTime": "2022-04-12T06:10:37Z",
    "Guidance": "Default",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": 1,
    "ProductId": "prod-bp18r7q127****",
    "TemplateUrl": "oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json",
    "TemplateType": "RosTerraformTemplate"
  },
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF"
}

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

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