All Products
Search
Document Center

Security Center:DescribeGroupedTags

Last Updated:Nov 25, 2024

Queries the statistics of asset tags.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeGroupedTagsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MachineTypesstringNo

The type of the asset to query. If you do not specify this parameter, the tags of all asset types are queried. Valid values:

  • ecs: server
  • cloud_product: Alibaba Cloud service
ecs

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code of the request.

200
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

151F6EB6-D5F3-417A-AF7B-4D84975DB586
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
Countinteger

This parameter is deprecated.

0
GroupedFiledsarray<object>

An array that consists of the statistics of the asset tags.

GroupedFiledobject
Namestring

The name of the tag.

InternetIp
Countstring

The number of assets to which the tag is added.

152
TagIdinteger

The ID of the tag.

3252366

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details