- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- API Documentation
- FAQs
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- API Documentation
- FAQs
- Glossary
1. API Description
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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 |
3. Output Parameters
| 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. |
4. Example
Example1 Associating resources with a tag
Input Example
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"
}
Output Example
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 | |
| 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. |
Yes
No
Was this page helpful?