All Products
Search
Document Center

Web Application Firewall:ListTagResources

Last Updated:Nov 15, 2024

Queries the tags that are added to a resource.

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-waf:ListTagResourcesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

caeba0bbb2be03f84eb48b699f0*****
ResourceTypestringYes

The type of the resource. Set the value to ALIYUN::WAF::DEFENSERESOURCE.

ALIYUN::WAF::DEFENSERESOURCE
ResourceIdarrayNo

The resource IDs. You can specify up to 50 resource IDs.

stringNo

The resource ID.

demo.xxxaliyundoc.com-waf
Tagarray<object>No

The tags that are added to the resource.

objectNo
KeystringNo

The key of tag N that is added to the resource. Valid values of N: 1 to 20.

Tagkey1
ValuestringNo

The value of tag N that is added to the resource. Valid values of N: 1 to 20.

TagValue1

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.

caeba0bbb2be03f84eb48b699f0*****
RequestIdstring

The request ID.

716E64DA-044F-51C7-B528-2FBF****AE4F
TagResourcesarray<object>

The list of resources.

TagResourceobject
ResourceTypestring

The type of the resource. ALIYUN::WAF::DEFENSERESOURCE is returned.

ALIYUN::WAF::DEFENSERESOURCE
TagValuestring

The value of tag N that is added to the resource.

TayValue1
ResourceIdstring

The resource ID.

c754d2a4-28f1-46df-b557-9586173a****
TagKeystring

The key of tag N that is added to the resource.

TagKey1

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "RequestId": "716E64DA-044F-51C7-B528-2FBF****AE4F",
  "TagResources": [
    {
      "ResourceType": "ALIYUN::WAF::DEFENSERESOURCE",
      "TagValue": "TayValue1",
      "ResourceId": "c754d2a4-28f1-46df-b557-9586173a****",
      "TagKey": "TagKey1"
    }
  ]
}

Error codes

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