产品概述
产品功能
应用场景
使用限制
支持标签 API 的资源类型
Domain name for API request: tag.intl.tencentcloudapi.com.
This API is used to associate resources with 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 Params. The value used for this API: AddResourceTag. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-13. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| TagKey | Yes | String | The tag key that needs to be bound. For the requirements, refer to: https://www.tencentcloud.com/document/product/651/13354?from_cn_redirect=1 |
| TagValue | Yes | String | The tag value that needs to be bound. For the requirements, refer to: https://www.tencentcloud.com/document/product/651/13354?from_cn_redirect=1 |
| Resource | Yes | String | Resource to be associated, represented in the standard six-segment resource format. For the correct format, see https://www.tencentcloud.com/document/product/651/89122?from_cn_redirect=1 |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tag.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddResourceTag
<Common request parameters>
{
"TagKey": "testTagKey",
"Resource": "qcs::cvm:ap-beijing:uin/1234567:instance/ins-123",
"TagValue": "testTagValue"
}{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}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 |
|---|---|
| FailedOperation | The operation failed. |
| FailedOperation.PolicyEnforcedInvalid | Enforcement restrictions in the tag policy. |
| InvalidParameter.ReservedTagKey | System reserved tag keys qcloud, tencent and project cannot be created. |
| InvalidParameterValue.ResourceDescriptionError | Resource description error. |
| InvalidParameterValue.TagKeyCharacterIllegal | Tag key contains illegal characters. |
| InvalidParameterValue.TagKeyEmpty | Tag key cannot be empty. |
| InvalidParameterValue.TagKeyLengthExceeded | Tag key length exceeds limit. |
| InvalidParameterValue.TagValueCharacterIllegal | Tag value contains illegal characters. |
| InvalidParameterValue.TagValueLengthExceeded | Tag value length exceeds limit. |
| LimitExceeded.ResourceAttachedTags | The number of tags associated with the resource exceeds the limit. |
| LimitExceeded.TagKey | The number of created tag keys reaches the limit of 1,000. |
| LimitExceeded.TagValue | Each tag key can have up to 1,000 values. |
| ResourceInUse.TagKeyAttached | The corresponding tag key has already been associated with the resource. |
文档反馈