All Products
Search
Document Center

Service Catalog:ListProductVersions

Last Updated:Apr 07, 2024

Queries the versions of a product.

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
ProductIdstringYes

The ID of the product.

prod-bp18r7q127****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductVersionDetailsobject []

The versions of the product.

Activeboolean

Indicates whether the product version is enabled. 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 recommended product version. Valid values:

  • Default (default): No product version is recommended.
  • Recommended: the stable version.
  • Latest: the latest version.
  • Deprecated: the version that is about to be deprecated.
Default
ProductVersionIdstring

The product version ID.

pv-bp15e79d26****
ProductVersionNamestring

The name of the product version.

1.0
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
ProductIdstring

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

prod-bp18r7q127****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
500InternalErrorA system error occurred.

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