You can call DescribeClusterServiceConfig operation to query the configuration details of a specified service in a cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeClusterServiceConfig |
The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to DescribeClusterServiceConfig. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions. |
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. |
ServiceName | String | No | TEZ |
The name of the service. You can call ListClusterService View data on the Member Management page. |
ConfigVersion | String | No | 0 |
The configured version information. You can use DescribeClusterServiceConfigHistory Interface to get. |
GroupId | String | No | 0 |
The ID of the configuration group. |
HostInstanceId | String | No | ecsId |
The instanceId information of the host, which usually corresponds to the ecsId information. |
TagValue | String | No | tez-site |
The tag information of the configuration to be queried. You can use the DescribeClusterServiceConfigTag Interface to get. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Config | Struct |
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 description of the coupon. |
ConfigValueList | Array of ConfigValue |
The list of configuration files for the service. |
|
ConfigValue | |||
AllowCustom | Boolean | true |
Indicates whether the current configuration file can contain custom configuration items. |
ConfigItemValueList | Array of ConfigItemValue |
The list of key-value pairs for the configuration item. |
|
ConfigItemValue | |||
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. |
Scope | String | None |
A reserved parameter. |
ScopeId | Long | 0 |
A reserved parameter. |
ConfigVersion | String | 0 |
The version of the configuration file. |
CreateTime | String | 1543312717000 |
The time when the configuration file was created. |
PropertyInfoList | Array of PropertyInfo |
The list of the property information for the configuration item. |
|
PropertyInfo | |||
Component | String | "" |
The name of the component. |
Description | String | "" |
The description of the configuration item. |
DisplayName | String | tez-site |
The display name. |
EffectWay | Struct |
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 | List | ["MEMORY"] |
The property type of the configuration item. |
PropertyValueAttributes | Struct |
The property of the configuration item value. |
|
Entries | Array of ValueEntryInfo |
A reserved parameter. |
|
ValueEntryInfo | |||
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 request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeClusterServiceConfig
&RegionId=cn-hangzhou
&ClusterId=C-F32FB31D8295****
&<common request parameters>
Sample success responses
XML
format
<RequestId>094585B2-13AF-4780-96B3-C8E925418B5D</RequestId>
<Config>
<Comment/>
<ServiceName>TEZ</ServiceName>
<PropertyInfoList>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<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/>
<Name>tez.lib.uris</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>/tmp/tez/staging</Value>
<DisplayName/>
<Name>tez.staging-dir</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
<propertyType>MEMORY</propertyType>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>#yarn_app_mapreduce_am_resource_mb#</Value>
<DisplayName/>
<Name>tez.am.resource.memory.mb</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
<propertyType>MEMORY</propertyType>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>0.8</Value>
<DisplayName/>
<Name>tez.container.max.java.heap.fraction</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService</Value>
<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/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>true</Value>
<DisplayName/>
<Name>tez.runtime.convert.user-payload.to.history-text</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>tez-site</FileName>
<Value>http://emr-header-1:8090/tez-ui2/</Value>
<DisplayName/>
<Name>tez.tez-ui.history-url.base</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<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/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<EffectWay/>
<FileName>user_params</FileName>
<Value>512</Value>
<DisplayName>tomcat_heapsize</DisplayName>
<Name>tomcat_heapsize</Name>
</PropertyInfo>
<PropertyInfo>
<PropertyTypes>
</PropertyTypes>
<Description/>
<PropertyValueAttributes>
<ReadOnly>false</ReadOnly>
<Type/>
<Maximum>2147483647</Maximum>
<Mimimum/>
<Hidden>false</Hidden>
<IncrememtStep/>
<Entries>
</Entries>
<Unit/>
</PropertyValueAttributes>
<ServiceName>TEZ</ServiceName>
<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>
JSON
Syntax
{"RequestId":"094585B2-13AF-4780-96B3-C8E925418B5D","Config":{"Comment":"","ServiceName":"TEZ","PropertyInfoList":{"PropertyInfo":[{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/","DisplayName":"","Name":"tez.lib.uris"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"/tmp/tez/staging","DisplayName":"","Name":"tez.staging-dir"},{"PropertyTypes":{"propertyType":["MEMORY"]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"#yarn_app_mapreduce_am_resource_mb#","DisplayName":"","Name":"tez.am.resource.memory.mb"},{"PropertyTypes":{"propertyType":["MEMORY"]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"0.8","DisplayName":"","Name":"tez.container.max.java.heap.fraction"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService","DisplayName":"","Name":"tez.history.logging.service.class"},{"PropertyTypes":{"propertyType":[]},"Description":"Publish configuration information to Timeline server.","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"true","DisplayName":"","Name":"tez.runtime.convert.user-payload.to.history-text"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"http://emr-header-1:8090/tez-ui2/","DisplayName":"","Name":"tez.tez-ui.history-url.base"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"tez-site","Value":"-Xmx512m","DisplayName":"tez.am.java.opts","Name":"tez.am.java.opts"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"user_params","Value":"512","DisplayName":"tomcat_heapsize","Name":"tomcat_heapsize"},{"PropertyTypes":{"propertyType":[]},"Description":"","PropertyValueAttributes":{"ReadOnly":false,"Type":"","Maximum":"2147483647","Mimimum":"","Hidden":false,"IncrememtStep":"","Entries":{"ValueEntryInfo":[]},"Unit":""},"ServiceName":"TEZ","EffectWay":{},"FileName":"user_params","Value":"emr-header-1","DisplayName":"do_init_host","Name":"do_init_host"}]},"ConfigVersion":"0","CreateTime":"1543312717000","Author":"1250460021754461","Applied":true,"ConfigValueList":{"ConfigValue":[{"ConfigName":"tez-site","AllowCustom":true,"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"}]}}]}}}