You can call this operation to query the configuration details of a 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 
RegionId String Yes cn-hangzhou

The ID of the region where your cluster resides.

ClusterId String Yes C-F32FB31D82954C64

The ID of the cluster.

Action String Yes DescribeClusterServiceConfig

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

ConfigVersion String No 0

The version of the configuration, which can be queried by calling the DescribeClusterServiceConfigHistory operation.

GroupId String No 0

The ID of the configuration group.

HostInstanceId String No ecsId

The instance ID of the host, corresponding to the ID of the ECS instance .

ServiceName String No TEZ

The name of the service.

TagValue String No tez-site

The tag of the configuration, which can be queried by calling the DescribeClusterServiceConfigTag operation.

AccessKeyId String No LTAI8ljWyu7y****

The AccessKey ID provided to you by Alibaba Cloud, which specifies the ID of the user.

Response parameters

Parameter Type Example Description 
Config

The description of the configuration.

Applied String true

Indicates whether the configuration takes effect.

Author String 111

The user who modified the configuration.

Comment String ""

The remarks.

ConfigValueList

The list of configuration files for the service.

ConfigValue

The information of configuration files for the service.

AllowCustom Boolean true

Indicates whether the current configuration file can contain custom configuration items.

ConfigItemValueList

The list of key-value pairs for the configuration item.

ConfigItemValue

The information of key-value pairs for the configuration item.

Description String ""

The description of the configuration item.

IsCustom Boolean  false

Indicates whether the configuration item is a custom configuration item.

ItemName String tez.history.logging.service.class

The name of the configuration item.

Value String org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService

The value of the configuration item.

ConfigName String tez-site

The name of the configuration file.

ConfigVersion String 0

The version of the configuration file.

CreateTime String 1543312717000

The time when the configuration file was created.

PropertyInfoList

The list of the property information for the configuration item.

PropertyInfo

The property information of the configuration item.

Component String ""

The name of the component.

Description String ""

The description of the configuration item.

DisplayName String tez-site

The display name.

EffectWay

A reserved parameter.

EffectType String ""

A reserved parameter.

InvokeServiceName String ""

A reserved parameter.

FileName String tez-site

The name of the configuration file.

Name String tez.lib.uris

The name of the configuration item.

PropertyTypes ["MEMORY"]

The property types of the configuration items.

propertyType

The property type of the configuration item.

PropertyValueAttributes

The property of the configuration item value.

Entries

A reserved parameter.

ValueEntryInfo

A reserved parameter.

Description String “”

A reserved parameter.

Label String “”

A reserved parameter.

Value String “”

A reserved parameter.

Hidden Boolean true

Indicates whether the configuration item is displayed.

IncrememtStep String 10

The increment step size of configuration item values.

Maximum String 10000

The maximum value of the configuration item.

Mimimum String 10

The minimum value of the configuration item.

ReadOnly Boolean true

Indicates whether the configuration item is read-only and cannot be modified.

Type String “”

A reserved parameter that does not take effect currently.

Unit String MB

The unit for the value of the configuration item.

ServiceName String TEZ

The name of the service.

Value String ${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/

The value template or example of the configuration item.

ServiceName String TEZ

The name of the service.

RequestId String 094585B2-13AF-4780-96B3-C8E925418B5D

The ID of the instance.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeClusterServiceConfig
&RegionId=cn-hangzhou
&ClusterId=C-F32FB31D82954C64
&<Common request parameters>

Sample success responses

XML format

<DescribeClusterServiceConfigResponse>
	  <RequestId>094585B2-13AF-4780-96B3-C8E925418B5D</RequestId>
	  <Config>
		    <Comment></Comment>
		    <ServiceName>TEZ</ServiceName>
		    <PropertyInfoList>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.lib.uris</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>/tmp/tez/staging</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.staging-dir</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes>
					          <propertyType>MEMORY</propertyType>
				        </PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>#yarn_app_mapreduce_am_resource_mb#</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.am.resource.memory.mb</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes>
					          <propertyType>MEMORY</propertyType>
				        </PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>0.8</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.container.max.java.heap.fraction</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.history.logging.service.class</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description>Publish configuration information to Timeline server. </Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>true</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.runtime.convert.user-payload.to.history-text</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>http://emr-header-1:8090/tez-ui2/</Value>
				        <DisplayName></DisplayName>
				        <Name>tez.tez-ui.history-url.base</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>tez-site</FileName>
				        <Value>-Xmx512m</Value>
				        <DisplayName>tez.am.java.opts</DisplayName>
				        <Name>tez.am.java.opts</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>user_params</FileName>
				        <Value>512</Value>
				        <DisplayName>tomcat_heapsize</DisplayName>
				        <Name>tomcat_heapsize</Name>
			      </PropertyInfo>
			      <PropertyInfo>
				        <PropertyTypes></PropertyTypes>
				        <Description></Description>
				        <PropertyValueAttributes>
					          <ReadOnly>false</ReadOnly>
					          <Type></Type>
					          <Maximum>2147483647</Maximum>
					          <Mimimum></Mimimum>
					          <Hidden>false</Hidden>
					          <IncrememtStep></IncrememtStep>
					          <Entries></Entries>
					          <Unit></Unit>
				        </PropertyValueAttributes>
				        <ServiceName>TEZ</ServiceName>
				        <EffectWay></EffectWay>
				        <FileName>user_params</FileName>
				        <Value>emr-header-1</Value>
				        <DisplayName>do_init_host</DisplayName>
				        <Name>do_init_host</Name>
			      </PropertyInfo>
		    </PropertyInfoList>
		    <ConfigVersion>0</ConfigVersion>
		    <CreateTime>1543312717000</CreateTime>
		    <Author>1250460021754461</Author>
		    <Applied>true</Applied>
		    <ConfigValueList>
			      <ConfigValue>
				        <ConfigName>tez-site</ConfigName>
				        <AllowCustom>true</AllowCustom>
				        <ConfigItemValueList>
					          <ConfigItemValue>
						            <Value>org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService</Value>
						            <ItemName>tez.history.logging.service.class</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>true</Value>
						            <ItemName>tez.runtime.convert.user-payload.to.history-text</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>640</Value>
						            <ItemName>tez.am.resource.memory.mb</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>http://emr-header-1:8090/tez-ui2/</Value>
						            <ItemName>tez.tez-ui.history-url.base</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/</Value>
						            <ItemName>tez.lib.uris</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>0.8</Value>
						            <ItemName>tez.container.max.java.heap.fraction</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>-Xmx512m</Value>
						            <ItemName>tez.am.java.opts</ItemName>
					          </ConfigItemValue>
					          <ConfigItemValue>
						            <Value>/tmp/tez/staging</Value>
						            <ItemName>tez.staging-dir</ItemName>
					          </ConfigItemValue>
				        </ConfigItemValueList>
			      </ConfigValue>
		    </ConfigValueList>
	  </Config>
</DescribeClusterServiceConfigResponse>

JSON format

{
	"Config":{
		"Applied":true,
		"PropertyInfoList":{
			"PropertyInfo":[
				{
					"Name":"tez.lib.uris",
					"Value":"${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.staging-dir",
					"Value":"/tmp/tez/staging",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.am.resource.memory.mb",
					"Value":"#yarn_app_mapreduce_am_resource_mb#",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[
							"MEMORY"
						]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.container.max.java.heap.fraction",
					"Value":"0.8",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[
							"MEMORY"
						]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.history.logging.service.class",
					"Value":"org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.runtime.convert.user-payload.to.history-text",
					"Value":"true",
					"Description":"Publish configuration information to Timeline server.",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.tez-ui.history-url.base",
					"Value":"http://emr-header-1:8090/tez-ui2/",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":""
				},
				{
					"Name":"tez.am.java.opts",
					"Value":"-Xmx512m",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"tez-site",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":"tez.am.java.opts"
				},
				{
					"Name":"tomcat_heapsize",
					"Value":"512",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"user_params",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":"tomcat_heapsize"
				},
				{
					"Name":"do_init_host",
					"Value":"emr-header-1",
					"Description":"",
					"ServiceName":"TEZ",
					"FileName":"user_params",
					"PropertyTypes":{
						"propertyType":[]
					},
					"EffectWay":{},
					"PropertyValueAttributes":{
						"ReadOnly":false,
						"Maximum":"2147483647",
						"Type":"",
						"Mimimum":"",
						"Hidden":false,
						"IncrememtStep":"",
						"Unit":"",
						"Entries":{
							"ValueEntryInfo":[]
						}
					},
					"DisplayName":"do_init_host"
				}
			]
		},
		"ConfigValueList":{
			"ConfigValue":[
				{
					"ConfigItemValueList":{
						"ConfigItemValue":[
							{
								"Value":"org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService",
								"ItemName":"tez.history.logging.service.class"
							},
							{
								"Value":"true",
								"ItemName":"tez.runtime.convert.user-payload.to.history-text"
							},
							{
								"Value":"640",
								"ItemName":"tez.am.resource.memory.mb"
							},
							{
								"Value":"http://emr-header-1:8090/tez-ui2/",
								"ItemName":"tez.tez-ui.history-url.base"
							},
							{
								"Value":"${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/",
								"ItemName":"tez.lib.uris"
							},
							{
								"Value":"0.8",
								"ItemName":"tez.container.max.java.heap.fraction"
							},
							{
								"Value":"-Xmx512m",
								"ItemName":"tez.am.java.opts"
							},
							{
								"Value":"/tmp/tez/staging",
								"ItemName":"tez.staging-dir"
							}
						]
					},
					"ConfigName":"tez-site",
					"AllowCustom":true
				}
			]
		},
		"ServiceName":"TEZ",
		"ConfigVersion":"0",
		"CreateTime":"1543312717000",
		"Author":"1250460021754461",
		"Comment":""
	},
	"RequestId":"094585B2-13AF-4780-96B3-C8E925418B5D"
}

Error codes

HTTP status code 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 allowed to manage resources of other users.
403 Invalid.Cluster.Status Invalid cluster status %s in status list The error message returned because the status of the specified cluster is invalid.
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list The error message returned because the type of the specified cluster is invalid.
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred. Submit a ticket.

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