You can call DescribeClusterServiceConfigTag operation to query the list of configuration tag values for a specified service of a cluster. The responses that are returned can be used to filter configuration items.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClusterServiceConfigTag

The operation that you want to perform. Set the value to DescribeClusterServiceConfigTag.

ClusterId String Yes C-F32FB31D8295****

The ID of the cluster. You can call ListClusters You can call this operation to view the ID of a cluster.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

ServiceName String Yes TEZ

The name of the service. You can call ListClusterService View data on the Member Management page.

ConfigTag String No PROPERTY_TYPE

The type of the tag. Supported value: PROPERTY_TYPE.

Response parameters

Parameter Type Example Description
ConfigTagList Array of ConfigTag

The list of tag types configured for the cluster.

ConfigTag
Tag String PROPERTY_TYPE

The type of the tag.

TagDesc String Configuration type

The description of the tag type.

ValueList Array of Value

The information of a tag value.

Value
Value String BASIC

The tag value.

ValueDesc String Basic Configurations

The description of the tag value.

RequestId String EBB4D49C-4064-4818-B3AE-4C6BE5FC8264

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeClusterServiceConfigTag
&ClusterId=C-F32FB31D8295****
&RegionId=cn-hangzhou
&ServiceName=TEZ
&<common request parameters>

Sample success responses

XML format

<ConfigTagList>
    <ConfigTag>
        <ValueList>
            <Value>
                <ValueDesc>tez-site</ValueDesc>
                <Value>tez-site</Value>
            </Value>
        </ValueList>
        <TagDesc>Configuration type</TagDesc>
        <Tag>FILE_NAME</Tag>
    </ConfigTag>
    <ConfigTag>
        <ValueList>
            <Value>
                <ValueDesc>Basic Configurations</ValueDesc>
                <Value>BASIC</Value>
            </Value>
            <Value>
                <ValueDesc>Advanced configuration</ValueDesc>
                <Value>ADVANCED</Value>
            </Value>
            <Value>
                <ValueDesc>Read only configuration</ValueDesc>
                <Value>INFORMATION</Value>
            </Value>
            <Value>
                <ValueDesc>Data path</ValueDesc>
                <Value>DATA_PATH</Value>
            </Value>
            <Value>
                <ValueDesc>Log path</ValueDesc>
                <Value>LOG_PATH</Value>
            </Value>
            <Value>
                <ValueDesc>Log related</ValueDesc>
                <Value>LOG</Value>
            </Value>
            <Value>
                <ValueDesc>JVM related</ValueDesc>
                <Value>JVM</Value>
            </Value>
            <Value>
                <ValueDesc>Data related</ValueDesc>
                <Value>DATA</Value>
            </Value>
            <Value>
                <ValueDesc>Database related</ValueDesc>
                <Value>DATABASE</Value>
            </Value>
            <Value>
                <ValueDesc>Performance related</ValueDesc>
                <Value>PERFORMANCE</Value>
            </Value>
            <Value>
                <ValueDesc>Time dependent</ValueDesc>
                <Value>TIME</Value>
            </Value>
            <Value>
                <ValueDesc>Codec correlation</ValueDesc>
                <Value>CODEC</Value>
            </Value>
            <Value>
                <ValueDesc>OSS related</ValueDesc>
                <Value>OSS</Value>
            </Value>
            <Value>
                <ValueDesc>Address port</ValueDesc>
                <Value>PORT</Value>
            </Value>
            <Value>
                <ValueDesc>Memory configuration</ValueDesc>
                <Value>MEMORY</Value>
            </Value>
            <Value>
                <ValueDesc>Disk related</ValueDesc>
                <Value>DISK</Value>
            </Value>
            <Value>
                <ValueDesc>Network related</ValueDesc>
                <Value>NETWORK</Value>
            </Value>
            <Value>
                <ValueDesc>File path</ValueDesc>
                <Value>PATH</Value>
            </Value>
            <Value>
                <ValueDesc>URL or URI</ValueDesc>
                <Value>URI</Value>
            </Value>
        </ValueList>
        <TagDesc>Configuration type</TagDesc>
        <Tag>PROPERTY_TYPE</Tag>
    </ConfigTag>
</ConfigTagList>
<RequestId>B887B2A3-E770-4340-A556-D9FAF41ABF47</RequestId>

JSON Syntax

{
    "ConfigTagList":
    {
        "ConfigTag":
        [
            {
                "ValueList":
                {
                    "Value":
                    [
                        {
                            "ValueDesc":"tez-site",
                            "Value":"tez-site"
                            }
                            ]
                            },
                            "TagDesc":"Configuration type",
                            "Tag":"FILE_NAME"
                            },
                            {
                                "ValueList":
                                {
                                    "Value":
                                    [
                                        {
                                            "ValueDesc":"Basic Configurations",
                                            "Value":"BASIC"
                                            },
                                            {
                                                "ValueDesc":"Advanced configuration",
                                                "Value":"ADVANCED"
                                                },
                                                {
                                                    "ValueDesc":"Read only configuration",
                                                    "Value":"INFORMATION"
                                                    },
                                                    {
                                                        "ValueDesc":"Data path",
                                                        "Value":"DATA_PATH"
                                                        },
                                                        {
                                                            "ValueDesc":"Log path",
                                                            "Value":"LOG_PATH"
                                                            },
                                                            {
                                                                "ValueDesc":"Log related",
                                                                "Value":"LOG"
                                                                },
                                                                {
                                                                    "ValueDesc":"JVM related",
                                                                    "Value":"JVM"
                                                                    },
                                                                    {
                                                                        "ValueDesc":"Data related",
                                                                        "Value":"DATA"
                                                                        },
                                                                        {
                                                                            "ValueDesc":"Database related",
                                                                            "Value":"DATABASE"
                                                                            },
                                                                            {
                                                                                "ValueDesc":"Performance related",
                                                                                "Value":"PERFORMANCE"
                                                                                },
                                                                                {
                                                                                    "ValueDesc":"Time dependent",
                                                                                    "Value":"TIME"
                                                                                    },
                                                                                    {
                                                                                        "ValueDesc":"Codec correlation",
                                                                                        "Value":"CODEC"
                                                                                        },
                                                                                        {
                                                                                            "ValueDesc":"OSS related",
                                                                                            "Value":"OSS"
                                                                                            },
                                                                                            {
                                                                                                "ValueDesc":"Address port",
                                                                                                "Value":"PORT"
                                                                                                },
                                                                                                {
                                                                                                    "ValueDesc":"Memory configuration",
                                                                                                    "Value":"MEMORY"
                                                                                                    },
                                                                                                    {
                                                                                                        "ValueDesc":"Disk related",
                                                                                                        "Value":"DISK"
                                                                                                        },
                                                                                                        {
                                                                                                            "ValueDesc":"Network related",
                                                                                                            "Value":"NETWORK"
                                                                                                            },
                                                                                                            {
                                                                                                                "ValueDesc":"File path",
                                                                                                                "Value":"PATH"
                                                                                                                },
                                                                                                                {
                                                                                                                    "ValueDesc":"URL or URI",
                                                                                                                    "Value":"URI"
                                                                                                                    }
                                                                                                                    ]
                                                                                                                    },
                                                                                                                    "TagDesc":"Configuration type",
                                                                                                                    "Tag":"PROPERTY_TYPE"
                                                                                                                    }
                                                                                                                    ]
                                                                                                                    },
                                                                                                                    "RequestId":"B887B2A3-E770-4340-A556-D9FAF41ABF47"
                                                                                                            }

Error codes

HttpCode Error code Error message Description
403 Params.Illegal The specified parameters are wrongly formed.. The error message returned because the format of the specified parameters is invalid.
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource The error message returned because you are not authorized to manage the resources of other users.
403 Invalid.Cluster.Status Invalid cluster status %s in status list The error message returned because the specified cluster status is invalid.
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list The error message returned because the specified cluster type is invalid.
404 ClusterId.NotFound The ClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Enter a valid value.
500 InternalError The request processing has failed due to some unknown error. The error message returned because the request processing has failed due to an internal error. Submit a ticket.

The port number of a client that accesses a Error CenterFor more information, see error codes.