You can call this operation to query configuration tags of a specified service in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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.

RegionId String Yes cn-hangzhou

The ID of the region to which your cluster belongs.

ServiceName String Yes TEZ

The name of the service.

ConfigTag String No FILE_NAME

The name of the tag.

AccessKeyId String No LTAI8ljWyu7y****

The AccessKey ID provided to you by Alibaba Cloud. This parameter identifies the user.

Response parameters

Parameter Type Example Description
ConfigTagList

The list of tags.

ConfigTag

The information of a tag.

Tag String FILE_NAME

The name of the tag.

TagDesc String The file to which the tag is attached

The description of the tag.

ValueList

The list of tag values.

Value

The information of a tag value.

Value String tez-site

The value of the tag.

ValueDesc String tez-site

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

<DescribeClusterServiceConfigTagResponse>
	  <ConfigTagList>
		    <ConfigTag>
			      <ValueList>
				        <Value>
					          <ValueDesc>tez-site</ValueDesc>
					          <Value>tez-site</Value>
				        </Value>
			      </ValueList>
			      <TagDesc>The file to which the tag is attached</TagDesc>
			      <Tag>FILE_NAME</Tag>
		    </ConfigTag>
		    <ConfigTag>
			      <ValueList>
				        <Value>
					          <ValueDesc>basic configurations</ValueDesc>
					          <Value>BASIC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>advanced configurations</ValueDesc>
					          <Value>ADVANCED</Value>
				        </Value>
				        <Value>
					          <ValueDesc>read-only configurations</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</ValueDesc>
					          <Value>LOG</Value>
				        </Value>
				        <Value>
					          <ValueDesc>JVM</ValueDesc>
					          <Value>JVM</Value>
				        </Value>
				        <Value>
					          <ValueDesc>data</ValueDesc>
					          <Value>DATA</Value>
				        </Value>
				        <Value>
					          <ValueDesc>database</ValueDesc>
					          <Value>DATABASE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>performance</ValueDesc>
					          <Value>PERFORMANCE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>time</ValueDesc>
					          <Value>TIME</Value>
				        </Value>
				        <Value>
					          <ValueDesc>coding and decoding</ValueDesc>
					          <Value>CODEC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>OSS</ValueDesc>
					          <Value>OSS</Value>
				        </Value>
				        <Value>
					          <ValueDesc>port address</ValueDesc>
					          <Value>PORT</Value>
				        </Value>
				        <Value>
					          <ValueDesc>memory configurations</ValueDesc>
					          <Value>MEMORY</Value>
				        </Value>
				        <Value>
					          <ValueDesc>disk</ValueDesc>
					          <Value>DISK</Value>
				        </Value>
				        <Value>
					          <ValueDesc>network</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>
</DescribeClusterServiceConfigTagResponse>

JSON format

{
	"RequestId":"B887B2A3-E770-4340-A556-D9FAF41ABF47",
	"ConfigTagList":{
		"ConfigTag":[
			{
				"Tag":"FILE_NAME",
				"TagDesc":"The tag is attached to a configuration file",
				"ValueList":{
					"Value":[
						{
							"Value":"tez-site",
							"ValueDesc":"tez-site"
						}
					]
				}
			},
			{
				"Tag":"PROPERTY_TYPE",
				"TagDesc":"configuration type",
				"ValueList":{
					"Value":[
						{
							"Value":"BASIC",
							"ValueDesc":"basic configurations"
						},
						{
							"Value":"ADVANCED",
							"ValueDesc":"advanced configurations"
						},
						{
							"Value":"INFORMATION",
							"ValueDesc":"read-only configurations"
						},
						{
							"Value":"DATA_PATH",
							"ValueDesc":"data path"
						},
						{
							"Value":"LOG_PATH",
							"ValueDesc":"log path"
						},
						{
							"Value":"LOG",
							"ValueDesc":"log"
						},
						{
							"Value":"JVM",
							"ValueDesc":"JVM"
						},
						{
							"Value":"DATA",
							"ValueDesc":"data"
						},
						{
							"Value":"DATABASE",
							"ValueDesc":"database"
						},
						{
							"Value":"PERFORMANCE",
							"ValueDesc":"performance"
						},
						{
							"Value":"TIME",
							"ValueDesc":"time"
						},
						{
							"Value":"CODEC",
							"ValueDesc":"coding and decoding"
						},
						{
							"Value":"OSS",
							"ValueDesc":"OSS"
						},
						{
							"Value":"PORT",
							"ValueDesc":"port address"
						},
						{
							"Value":"MEMORY",
							"ValueDesc":"memory configurations"
						},
						{
							"Value":"DISK",
							"ValueDesc": "disk"
						},
						{
							"Value":"NETWORK",
							"ValueDesc":"network"
						},
						{
							"Value":"PATH",
							"ValueDesc":"file path"
						},
						{
							"Value":"URI",
							"ValueDesc":"URL or URI"
						}
					]
				}
			}
		]
	}
}

Error codes

HTTP status code Error code Error message Operation
403 Params.Illegal The specified parameters are wrongly formed. The error message returned because the format of the specified parameter 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 ClusterId parameter does not exist. Make sure that the ID of the cluster is valid.
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.

For a list of error codes, visit the API Error Center.