Domain name for API request: tag.tencentcloudapi.com.
This API is used to query resource list by tags.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeResourcesByTagsUnion. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-13. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| TagFilters.N | Yes | Array of TagFilter | Tag filtering arrays. |
| CreateUin | No | Integer | Tag creator uin. |
| Offset | No | Integer | Data offset. The default value is 0. Must be an integral multiple of the Limit parameter. |
| Limit | No | Integer | Page size. The default value is 15. |
| ResourcePrefix | No | String | Resource prefix. |
| ResourceId | No | String | Unique resource ID. |
| ResourceRegion | No | String | The resource’s region. |
| ServiceType | No | String | Service type |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of results. |
| Offset | Integer | Data offset. |
| Limit | Integer | The size of each page. |
| Rows | Array of ResourceTag | Resource tag. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tag.tencentcloudapi.com/?Action=DescribeResourcesByTagsUnion
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
"ResourceId": "ins-1234"
&TagFilters.0.TagKey=key1
&<Common Request Parameters>{
"Response": {
"TotalCount": 1,
"Offset": 0,
"Limit": 15,
"Rows": [
{
"ResourceRegion": "ap-guangzhou",
"ServiceType": "cvm",
"ResourcePrefix": "instance",
"ResourceId": "ins-asdfsadf",
"Tags": [
{
"TagKey": "key1",
"TagValue": "value1"
}
]
}
],
"RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.TagFilters | TagFilters parameter error |
| InvalidParameterValue.TagFiltersLengthExceeded | Tag filtering arrays reached the upper limit 6 when querying resources by tag. |
| InvalidParameterValue.UinInvalid | Uin parameter is invalid. |
Was this page helpful?