GetProductAsAdmin - Service Catalog - Alibaba Cloud Documentation Center

Queries the information about a product as the administrator.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProductId	string	Yes	The ID of the product.	prod-bp18r7q127****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetail	object	The information about the product.
ProductArn	string	The Alibaba Cloud Resource Name (ARN) of the product.	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	The description of the product.	This is a product description.
CreateTime	string	The creation time. 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
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-Create an ECS instance
ProviderName	string	The provider of the product.	IT team
ProductType	string	The type of the product. The value is fixed as Ros, which indicates Resource Orchestration Service (ROS).	Ros
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
TagOptions	object []	The tag options associated with the product.
Active	boolean	Indicates whether the tag option is enabled. Valid values: true (default) false	true
TagOptionId	string	The ID of the tag option.	tag-bp1q65xd3j****
Key	string	The key of the tag option.	k1
Value	string	The value of the tag option.	v1
Owner	string	The ID of the owner of the tag option.	133413081827****

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetail": {
    "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
    "Description": "This is a product description.\n",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create an ECS instance\n",
    "ProviderName": "IT team\n",
    "ProductType": "Ros",
    "TemplateType": "RosTerraformTemplate"
  },
  "TagOptions": [
    {
      "Active": true,
      "TagOptionId": "tag-bp1q65xd3j****",
      "Key": "k1",
      "Value": "v1",
      "Owner": "133413081827****\n"
    }
  ]
}

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.

Change history

Change time

Summary of changes

Operation

2024-02-27

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-03-24

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.