Domain name for API request: tag.tencentcloudapi.com.
This API is used to query tag key and value pairs for existing resources.
A maximum of 100 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: DescribeResourceTagsByResourceIds. |
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. |
ServiceType | Yes | String | Service type. |
ResourcePrefix | Yes | String | Resource prefix. |
ResourceIds.N | Yes | Array of String | Unique resource ID. |
ResourceRegion | Yes | String | The resource's region. |
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 0. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of results. |
Offset | Integer | Data offset. |
Limit | Integer | Page size. |
Tags | Array of TagResource | Tag list. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tag.tencentcloudapi.com/?Action=DescribeResourceTagsByResourceIds
&ServiceType=cvm&ResourcePrefix=instance&ResourceRegion=ap-beijing&ResourceIds.0=ins-1234
&<common request parameters>
{
"Response": {
"TotalCount": 1,
"Offset": 0,
"Limit": 15,
"Tags": [
{
"TagKey": "string",
"TagValue": "string",
"TagKeyMd5": "cc4dd1da7e1a754534215f02fb9ba85d",
"TagValueMd5": "cc4dd1da7e1a754534215f02fb9ba85d",
"ResourceId": "ins-1234"
}
],
"RequestId": "34bdd6cc-34b0-4ef4-9051-be9a5294be8e"
}
}
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.RegionInvalid | Region error. |
InvalidParameterValue.ResourceIdInvalid | Resource ID error. |
InvalidParameterValue.ResourcePrefixInvalid | Resource prefix error. |
InvalidParameterValue.ServiceTypeInvalid | Service type error. |
InvalidParameterValue.UinInvalid | Uin parameter is invalid. |
Was this page helpful?