tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyResourceTags

Last updated: 2024-11-22 10:16:13

    1. API Description

    Domain name for API request: tag.intl.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 Params. The value used for this API: ModifyResourceTags.
    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.
    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. This parameter can be omitted, but it cannot be an empty array.
    DeleteTags.N No Array of TagKeyObject The tags to be disassociated. This API must contain either ReplaceTags or DeleteTag, and these two parameters cannot include the same tag keys. This parameter can be omitted, but it cannot be an empty array.

    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 Unassociating multiple tags from a resource

    Input Example

    POST / HTTP/1.1
Host: tag.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyResourceTags
<Common request parameters>

{
    "DeleteTags": [
        {
            "TagKey": "testTagKey2"
        },
        {
            "TagKey": "testTagKey1"
        }
    ],
    "Resource": "qcs::cvm:ap-beijing:uin/1234567:instance/ins-123"
}

    Output Example

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

    Example2 Replacing tags associated with a resource with input tags

    Input Example

    POST / HTTP/1.1
Host: tag.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyResourceTags
<Common request parameters>

{
    "ReplaceTags": [
        {
            "TagKey": "testTagKey2",
            "TagValue": "testTagValue2"
        },
        {
            "TagKey": "testTagKey1",
            "TagValue": "testTagValue1"
        }
    ],
    "Resource": "qcs::cvm:ap-beijing:uin/1234567:instance/ins-123"
}

    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.

    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.
    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.Quota The quota limit is reached.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy