tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeResourcesByTags

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

    1. API Description

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

    This API is used to query resources by tags.

    A maximum of 100 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: DescribeResourcesByTags.
    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.
    TagFilters.N Yes Array of TagFilter Tag filtering arrays.
    CreateUin No Integer Tag creator uin.
    Offset No Integer Data offset. The default value is 0. Must be an integral multiple of the Limit parameter.
    Limit No Integer Page size. The default value is 15.
    ResourcePrefix No String Resource prefix.
    ResourceId No String Unique resource ID.
    ResourceRegion No String The resource's region.
    ServiceType No String Service type.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of results.
    Offset Integer Data offset.
    Limit Integer Number of entries per page.
    Note: This field may return null, indicating that no valid value is found.
    Rows Array of ResourceTag Resource tag.
    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 Querying resource list by tags

    Input Example

    https://tag.tencentcloudapi.com/?Action=DescribeResourcesByTags
&ServiceType=cvm
&ResourcePrefix=instance
&ResourceRegion=ap-beijing
&ResourceId=ins-1234
&TagFilters.0.TagKey=key1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "Offset": 0,
        "Limit": 15,
        "Rows": [
            {
                "ResourceRegion": "ap-guangzhou",
                "ServiceType": "cvm",
                "ResourcePrefix": "instance",
                "ResourceId": "ins-1234",
                "Tags": [
                    {
                        "TagKey": "key1",
                        "TagValue": "value1"
                    }
                ]
            }
        ],
        "RequestId": "5024400f-ae5c-4080-b3ca-f45bf9dae21a"
    }
}

    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.
    InvalidParameterValue.TagFilters TagFilters parameter error
    InvalidParameterValue.TagFiltersLengthExceeded Tag filtering arrays reached the upper limit 6 when querying resources by tag.
    InvalidParameterValue.UinInvalid Uin parameter is invalid.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy