ModifyResourceTags

Last updated: 2020-08-07 10:46:11

1. API Description

Domain name for API request: tag.tencentcloudapi.com.

This API is used to modify all tags associated with a resource.

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 parameter. The value used for this API: ModifyResourceTags.
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.
Resource Yes String Six-segment resource description
ReplaceTags.N No Array of Tag The tags to be added or modified. If the resource described by Resource is not associated with the input tag keys, an association will be added. If the tag keys are already associated, the values corresponding to the associated tag keys will be modified to the input values. This API must contain either ReplaceTags or DeleteTag. And these two parameters cannot include the same tag keys.
DeleteTags.N No Array of TagKeyObject The tags to be unassociated. This API must contain either ReplaceTags or DeleteTag. And these two parameters cannot include the same tag keys.

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 Replacing Tags Associated with a Resource with Input Tags

Input Example

https://tag.tencentcloudapi.com/?Action=ModifyResourceTags
&Resource=qcs::cvm:ap-beijing:uin/1234567:instance/ins-123
&ReplaceTags.0.TagKey=testTagKey1
&ReplaceTags.0.TagValue=testTagValue1
&ReplaceTags.1.TagKey=testTagKey2
&ReplaceTags.1.TagValue=testTagValue2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

Example2 Unassociating Tags from a Resource

Input Example

https://tag.tencentcloudapi.com/?Action=ModifyResourceTags
&Resource=qcs::cvm:ap-beijing:uin/1234567:instance/ins-123
&DeleteTags.0.TagKey=testTagKey1
&DeleteTags.1.TagKey=testTagKey2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
InvalidParameter.ReservedTagKey System reserved tag keys qcloud, tencent and project cannot be created.
InvalidParameter.Tag Tag parameter error.
InvalidParameterValue.DeleteTagsParamError DeleteTags cannot contain the elements in ReplaceTags or AddTags.
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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help