All Products
Search

This Product

    ApsaraDB for ClickHouse:ListTagResources

    Document Center

    ApsaraDB for ClickHouse:ListTagResources

    Last Updated:Dec 10, 2025

    Lists the tags that are attached to ApsaraDB for ClickHouse clusters.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    Note

    You can call the DescribeRegions operation to query region IDs.

    cn-hangzhou
    ResourceType

    string

    Yes

    The resource type. Set the value to DBCLUSTER.

    DBCLUSTER
    NextToken

    string

    No

    The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first query. If a query does not return all results, a NextToken value is returned. You can use this token in a subsequent query to retrieve the next page of results.

    212db86sca4384811e0b5e8707ec21345
    ResourceId

    array

    No

    The resource ID.

    string

    No

    The ID of the cluster. You can specify N cluster IDs. The value of N is an integer from 1 to 50.

    Note

    • You can call the DescribeDBClusters operation to query the information about all clusters in a region, including cluster IDs.

    • If you specify the Tag.N.Key parameter, you can leave this parameter empty.

    cc-bp1t9lbb7a4z7****
    Tag

    array<object>

    No

    The list of tags.

    object

    No

    The list of tags.

    Key

    string

    No

    The tag key. You can specify from 1 to 20 tag keys.

    Note

    If you specify the ResourceId.N parameter, you can leave this parameter empty.

    testkey1
    Value

    string

    No

    The value of the tag. You can specify from 1 to 20 tag values.

    Note

    You can leave this parameter empty.

    testvalue1

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    184DE106-CB2C-4DD2-B57F-396652E6C8F8
    NextToken

    string

    The token that is used to retrieve the next page of results. This parameter is returned only if the results are not fully returned in the current request. You can use this token in a subsequent request to retrieve the next page of results.

    212db86sca4384811e0b5e8707ec21345
    TagResources

    array<object>

    Information about the clusters and their tags.

    object

    TagValue

    string

    The value of the tag.

    testvalue1
    TagKey

    string

    The tag key.

    testkey1
    ResourceType

    string

    The resource type. The value is DBCLUSTER.

    DBCLUSTER
    ResourceId

    string

    cc-bp1t9lbb7a4z7****

    Examples

    Success response

    JSON format

    {
  "RequestId": "184DE106-CB2C-4DD2-B57F-396652E6C8F8",
  "NextToken": "212db86sca4384811e0b5e8707ec21345",
  "TagResources": [
    {
      "TagValue": "testvalue1",
      "TagKey": "testkey1",
      "ResourceType": "DBCLUSTER",
      "ResourceId": "cc-bp1t9lbb7a4z7****"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.