You can call this operation to view the configurations of a specified service of a cluster.

Request parameters

Name Type Required Example Description
ClusterId String Yes C-EBD62A703A430E23 The ID of the cluster.
RegionId String Yes cn-hangzhou The region location ID.
ConfigVersion String No 0 The configuration version, which you can obtain by calling the DescribeClusterServiceConfigHistory operation.
GroupId String No 0 The ID of the configuration group.
HostInstanceId String No ecsId The ID of the instance.
ServiceName String No TEZ The name of the service.
TagValue String No tez-site The tag value of the configuration file, which can be obtained by calling the DescribeClusterServiceConfigTag operation.
AccessKeyId String No xxx The AccessKey ID.

Response parameters

Name Type Example Description
RequestId String 094585B2-13AF-4780-96B3-C8E925418B5D The ID of the request.
Config The detail of the configuration.
ServiceName String TEZ The name of the service.
ConfigVersion String 0 The configuration version.
Applied String true Indicates whether the configuration takes effect.
CreateTime String 1543312717000 The time at which the domain name was created.
Author String 111 The author.
Comment String "" The comment.
ConfigValueList The list of configuration files for the service.
ConfigName String tez-site The name of the configuration file.
AllowCustom Boolean true Indicates whether the current configuration file allows custom configuration items.
ConfigItemValueList The key-value pairs of the 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.
IsCustom Boolean false Indicates whether the configuration item is custom.
Description String "" The description of the configuration item.
PropertyInfoList The property information of the configuration item.
Name String tez.lib.uris The name of the configuration item.
Value String ${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/ The template of the configuration item value.
Description String "" The description of the configuration item.
FileName String tez-site The name of the configuration file.
DisplayName String tez-site The displayed name.
ServiceName String TEZ The name of the service.
Component String "" The name of the component.
PropertyTypes String ["MEMORY"] The property type of the configuration item.
PropertyValueAttributes The property value of the configuration item.
Type String "" A reserved parameter. Currently invalid.
Maximum String 10000 The maximum value.
Mimimum String 10 The mimimum value.
Unit String MB The unit of the configuration item value.
ReadOnly Boolean true Indicates whether the configuration item is read-only (cannot be modified).
Hidden Boolean true Indicates whether the configuration item is displayed.
IncrememtStep String 10 The increment of the value.
Entries A reserved parameter.
Value String "" A reserved parameter.
Label String "" A reserved parameter.
Description String "" A reserved parameter.
EffectWay A reserved parameter.
EffectType String "" A reserved parameter.
InvokeServiceName String "" A reserved parameter.

Examples

  • Sample requests
    /? ClusterId=C-F32FB31D82954C64
    &RegionId=cn-hangzhou
    &AccessKeyId=akId
    &ConfigVersion=0
    &GroupId=0
    &HostInstanceId=ecsId
    &ServiceName=TEZ
    &TagValue=tez-site
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"Config":{
    		"Applied":true,
    		"Author":"1250460021754461",
    		"Comment":"",
    		"ConfigValueList":{
    			"ConfigValue":[{
    				"AllowCustom":true,
    				"ConfigItemValueList":{
    					"ConfigItemValue":[
    						{
    							"ItemName":"tez.history.logging.service.class",
    							"Value":"org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService"
    						},
    						{
    							"ItemName":"tez.runtime.convert.user-payload.to.history-text",
    							"Value":"true"
    						},
    						{
    							"ItemName":"tez.am.resource.memory.mb",
    							"Value":"640"
    						},
    						{
    							"ItemName":"tez.tez-ui.history-url.base",
    							"Value":"http://emr-header-1:8090/tez-ui2/"
    						},
    						{
    							"ItemName":"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/"
    						},
    						{
    							"ItemName":"tez.container.max.java.heap.fraction",
    							"Value":"0.8"
    						},
    						{
    							"ItemName":"tez.am.java.opts",
    							"Value":"-Xmx512m"
    						},
    						{
    							"ItemName":"tez.staging-dir",
    							"Value":"/tmp/tez/staging"
    						}
    					]
    				},
    				"ConfigName":"tez-site"
    			}]
    		},
    		"ConfigVersion":"0",
    		"CreateTime":"1543312717000",
    		"PropertyInfoList":{
    			"PropertyInfo":[
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.lib.uris",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/"
    				},
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.staging-dir",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"/tmp/tez/staging"
    				},
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.am.resource.memory.mb",
    					"PropertyTypes":{
    						"propertyType":["MEMORY"]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"#yarn_app_mapreduce_am_resource_mb#"
    				},
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.container.max.java.heap.fraction",
    					"PropertyTypes":{
    						"propertyType":["MEMORY"]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"0.8"
    				},
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.history.logging.service.class",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService"
    				},
    				{
    					"Description":"Publish configuration information to Timeline server.",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.runtime.convert.user-payload.to.history-text",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"true"
    				},
    				{
    					"Description":"",
    					"DisplayName":"",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.tez-ui.history-url.base",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"http://emr-header-1:8090/tez-ui2/"
    				},
    				{
    					"Description":"",
    					"DisplayName":"tez.am.java.opts",
    					"EffectWay":{},
    					"FileName":"tez-site",
    					"Name":"tez.am.java.opts",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"-Xmx512m"
    				},
    				{
    					"Description":"",
    					"DisplayName":"tomcat_heapsize",
    					"EffectWay":{},
    					"FileName":"user_params",
    					"Name":"tomcat_heapsize",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"512"
    				},
    				{
    					"Description":"",
    					"DisplayName":"do_init_host",
    					"EffectWay":{},
    					"FileName":"user_params",
    					"Name":"do_init_host",
    					"PropertyTypes":{
    						"propertyType":[]
    					},
    					"PropertyValueAttributes":{
    						"Entries":{
    							"ValueEntryInfo":[]
    						},
    						"Hidden":false,
    						"IncrememtStep":"",
    						"Maximum":"2147483647",
    						"Mimimum":"",
    						"ReadOnly":false,
    						"Type":"",
    						"Unit":""
    					},
    					"ServiceName":"TEZ",
    					"Value":"emr-header-1"
    				}
    			]
    		},
    		"ServiceName":"TEZ"
    	},
    	"RequestId":"094585B2-13AF-4780-96B3-C8E925418B5D"
    }
  • Error response examples
    JSON format
    {
    	"code":"RAM.Permission.NotAllow",
    	"message":"It is not allow to execute this operation,please use RAM to authorize!",
    	"requestId":"9AEDC439-1F63-491D-B8C6-9737C372BF3A",
    	"successResponse":false
    }

Error codes

View error codes.