调用DescribeClusterServiceConfig接口，查询集群指定服务的配置详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeClusterServiceConfig

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求，该参数为必选参数。取值：DescribeClusterServiceConfig。
RegionId String 是 cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ClusterId String 是 C-F32FB31D8295****

集群ID。您可以调用ListClusters查看集群的ID。

ServiceName String 否 TEZ

服务名称。您可以调用ListClusterService查看。

ConfigVersion String 否 0

配置的版本信息，可通过 DescribeClusterServiceConfigHistory 接口获取。

GroupId String 否 0

当前配置组的ID信息。
HostInstanceId String 否 ecsId

主机的instanceId信息，通常对应的是ecsId信息。
TagValue String 否 tez-site

待查询的配置的标签信息，可通过DescribeClusterServiceConfigTag接口获取。

返回数据

名称 类型 示例值 描述
Config Struct

配置的详情信息。
Applied String true

当前是否已经生效。
Author String 111

修改人。
Comment String ""

备注。
ConfigValueList Array of ConfigValue

服务的配置文件列表。
ConfigValue
AllowCustom Boolean true

当前配置文件是否允许自定义配置项。
ConfigItemValueList Array of ConfigItemValue

配置项的K-V对。
ConfigItemValue
Description String ""

配置项的描述信息。
IsCustom Boolean false

是否为自定义配置项。
ItemName String tez.history.logging.service.class

配置项名称。
Value String org.apache.tez.dag.history.logging.ats.ATSHistoryLoggingService

配置项的值。
ConfigName String tez-site

配置文件名。
Scope String 无

保留参数。
ScopeId Long 0

保留参数。
ConfigVersion String 0

配置版本。
CreateTime String 1543312717000

创建时间。
PropertyInfoList Array of PropertyInfo

配置项的属性信息。
PropertyInfo
Component String ""

组件名。
Description String ""

配置项的描述信息。
DisplayName String tez-site

展示名称。
EffectWay Struct

预留字段。
EffectType String ""

预留字段。
InvokeServiceName String ""

预留字段。
FileName String tez-site

配置文件名。
Name String tez.lib.uris

配置项名称。
PropertyTypes List ["MEMORY"]

配置项的属性类型。
PropertyValueAttributes Struct

配置项的值的属性信息。
Entries Array of ValueEntryInfo

预留字段。
ValueEntryInfo
Description String “”

预留字段。
Label String “”

预留字段。
Value String “”

预留字段。
Hidden Boolean true

是否展示。
IncrememtStep String 10

递增类型的Value的递增步长。
Maximum String 10000

最大值。
Mimimum String 10

最小值。
ReadOnly Boolean true

配置项是否只读（不能修改）。
Type String “”

预留字段，暂时不生效。
Unit String MB

配置项值的单位。
ServiceName String TEZ

服务名称。
Value String ${fs.defaultFS}/apps/tez-0.9.1-1.0.2/,${fs.defaultFS}/apps/tez-0.9.1-1.0.2/lib/

配置项的value模板或者示例。
ServiceName String TEZ

服务名称。
RequestId String 094585B2-13AF-4780-96B3-C8E925418B5D

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeClusterServiceConfig
&RegionId=cn-hangzhou
&ClusterId=C-F32FB31D8295****
&<公共请求参数>

正常返回示例

XML 格式 

<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 格式 

{"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"}]}}]}}}