1. API Description
Domain name for API request: tag.tencentcloudapi.com.
This API is used to associate a tag with multiple resources.
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: AttachResourcesTag. |
| 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. |
| ServiceType | Yes | String | Resource service name (the third segment in the six-segment resource description) |
| ResourceIds.N | Yes | Array of String | Resource ID array, which can contain up to 50 resources |
| TagKey | Yes | String | Tag key |
| TagValue | Yes | String | Tag value |
| ResourceRegion | No | String | Resource region. If resources have the region attribute, this field is required; otherwise, it is optional. |
| ResourcePrefix | No | String | Resource prefix (the part before "/" in the last segment in the six-segment resource description), which is optional for COS buckets but required for other Tencent Cloud resources. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Associating a tag with multiple CVM instances in Guangzhou
Input Example
https://tag.tencentcloudapi.com/?Action=AttachResourcesTag
&ServiceType=cvm
&ResourceRegion=ap-guangzhou
&TagKey=t1
&TagValue=v1
&ResourcePrefix=instance
&ResourceIds.0=ins-001
&ResourceIds.1=ins-002
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "7bf7fd57-4d48-4a5a-957a-80b390dea117"
}
}
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 NodeJS
- 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 |
|---|---|
| AuthFailure.UnauthorizedOperation | CAM authentication failed. |
| FailedOperation | The operation failed. |
| FailedOperation.ResourceAppIdNotSame | The appId of resources in one single request must be the same. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.ReservedTagKey | System reserved tag keys qcloud, tencent and project cannot be created. |
| InvalidParameterValue.RegionInvalid | Region error. |
| InvalidParameterValue.ResourceDescriptionError | Resource description error. |
| InvalidParameterValue.ResourceIdInvalid | Resource ID error. |
| InvalidParameterValue.ResourcePrefixInvalid | Resource prefix error. |
| InvalidParameterValue.ServiceTypeInvalid | Service type error. |
| InvalidParameterValue.TagKeyCharacterIllegal | Tag key contains illegal characters. |
| InvalidParameterValue.TagKeyEmpty | Tag key cannot be empty. |
| InvalidParameterValue.TagValueCharacterIllegal | Tag value contains illegal characters. |
| InvalidParameterValue.UinInvalid | Uin parameter is invalid. |
| LimitExceeded.ResourceAttachedTags | The number of tags associated with the resource exceeds the limit. |
| LimitExceeded.ResourceNumPerRequest | The number of resources requested at a time reaches the upper limit. |
| OperationDenied | Operation denied. |
| ResourceInUse.TagKeyAttached | The corresponding tag key has already been associated with the resource. |
| ResourceNotFound.TagNonExist | Tag does not exist. |
Yes
No
Was this page helpful?