DescribeGroupedTags API Reference for Asset Tag Grouping - Security Center - Alibaba Cloud - Security Center

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

yundun-sas:DescribeGroupedTags

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MachineTypes	string	No	The type of asset to query. If you do not specify an asset type, tag information for all asset types is queried. Valid values: ecs: server cloud_product: cloud product.	ecs

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code of the request.	200
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	151F6EB6-D5F3-417A-AF7B-4D84975DB586
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Count	integer	This parameter is deprecated and can be ignored.	0
GroupedFileds	array<object>	The statistics information of asset labels.
	object
Name	string	The tag name.	InternetIp
Count	string	The number of assets associated with the tag.	152
TagId	integer	The tag ID.	3252366

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "151F6EB6-D5F3-417A-AF7B-4D84975DB586",
  "Success": true,
  "Count": 0,
  "GroupedFileds": [
    {
      "Name": "InternetIp",
      "Count": "152",
      "TagId": 3252366
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.