Use GetProductAsAdmin to query product information - Service Catalog

Queries the information about a product as the administrator.

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:GetProductAsAdmin

get

*Product

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

None

Request parameters

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

Response elements

Element	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 ECS
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	array<object>	The tag options associated with the product.
	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

Success response

JSON format

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetail": {
    "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
    "Description": "This is a product description",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create ECS",
    "ProviderName": "IT team",
    "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	Description
500	InternalError	A system error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.