tencent cloud

Feedback

UnTagResources

Last updated: 2024-03-20 15:31:06

    1. API Description

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

    This API is used to unbind a tag uniformly from multiple specified resources of multiple Tencent Cloud services.

    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: UnTagResources.
    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.
    ResourceList.N Yes Array of String Six-segment resource description list. Tencent Cloud uses a six-segment value to describe a resource. For more information, see CAM > Overview > API List > Six-Segment Resource Information.
    For example: ResourceList.1 = qcs::${ServiceType}:${Region}:uin/${Account}:${ResourcePrefix}/${ResourceId}.
    Value range of N: 0–9
    TagKeys.N Yes Array of String Tag key.
    Value range: 0–9

    3. Output Parameters

    Parameter Name Type Description
    FailedResources Array of FailedResource Information of failed resources.
    When tag unbinding succeeds, the returned FailedResources will be empty.
    When tag unbinding partially or completely fails, the returned FailedResources will display the details of failed resources.
    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 Unbinding tag from resource

    Input Example

    POST / HTTP/1.1
    Host: tag.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UnTagResources
    <Common request parameters>
    
    {
        "ResourceList": [
            "qcs::cvm:ap-beijing:uin/10000055****:instance/****",
            "qcs::cvm:ap-beijing:uin/10000055****:instance/****"
        ],
        "TagKeys": [
            "RWFGaltFlR",
            "LbDKGjeagV"
        ]
    }
    

    Output Example

    {
        "Response": {
            "FailedResources": [],
            "RequestId": "cbc7b26c-3fff-4a3c-82f0-c6ebc2ff31e3"
        }
    }
    

    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
    AuthFailure.UnauthorizedOperation CAM authentication failed.
    FailedOperation The operation failed.
    FailedOperation.PolicyEnforcedInvalid
    FailedOperation.ResourceTagProcessing The resource tag is being processed.
    InvalidParameter Incorrect parameter.
    InvalidParameter.ReservedTagKey System reserved tag keys qcloud, tencent and project cannot be created.
    InvalidParameter.Tag Tag parameter error.
    InvalidParameterValue.ResourceDescriptionError Resource description error.
    InvalidParameterValue.TagKeyCharacterIllegal Tag key contains illegal characters.
    InvalidParameterValue.TagKeyDuplicate There are duplicate TagKeys in TagList.
    InvalidParameterValue.TagKeyEmpty Tag key cannot be empty.
    InvalidParameterValue.TagKeyLengthExceeded Tag key length exceeds limit.
    InvalidParameterValue.TagValueCharacterIllegal Tag value contains illegal characters.
    LimitExceeded.ResourceNumPerRequest The number of resources requested at a time reaches the upper limit.
    LimitExceeded.TagNumPerRequest The number of tags in a single request exceeds the limit.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support