Query product version details with GetProductVersion - Service Catalog

Queries a product version.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicecatalog:GetProductVersion

get

*Product

acs:servicecatalog:{#regionId}:{#accountId}:product/{#ProductId}

None

Request parameters

Parameter	Type	Required	Description	Example
ProductVersionId	string	Yes	The ID of the product version.	pv-bp15e79d26****

Response elements

Element	Type	Description	Example
	object	The response parameters.
ProductVersionDetail	object	The details of the product version.
Active	boolean	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
Description	string	The description of the product version.	This is a product version description
CreateTime	string	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
Guidance	string	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
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProductVersionName	string	The name of the product version.	1.0
ProductId	string	The ID of the product to which the product version belongs.	prod-bp18r7q127****
TemplateUrl	string	The URL of the template.	oss://servicecatalog-cn-hangzhou/146611588617**/terraform/template/tpl-bp1217we23**/template.json
TemplateType	string	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
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF

Examples

Success response

JSON format

{
  "ProductVersionDetail": {
    "Active": true,
    "Description": "This is a product version description",
    "CreateTime": "2022-04-12T06:10:37Z",
    "Guidance": "Default",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0",
    "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 code	Error code	Error message	Description
500	InternalError	A system error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.