调用 DescribeClusterServiceConfigTag 接口,查询集群指定服务的配置标签列表。

调试

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

请求参数

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

系统规定参数。取值:DescribeClusterServiceConfigTag。

ClusterId String C-F32FB31D8295****

集群ID。

RegionId String cn-hangzhou

地域ID。

ServiceName String TEZ

服务名称。

ConfigTag String FILE_NAME

标签名。

AccessKeyId String LTAI8ljWyu7y****

阿里云AccessKey ID信息,用于标识访问者身份。

返回数据

名称 类型 示例值 描述
ConfigTagList

标签列表。

ConfigTag

标签列表。

Tag String FILE_NAME

标签名。

TagDesc String 所属文件

标签描述。

ValueList

标签值列表。

Value

标签值列表。

Value String tez-site

标签的Value。

ValueDesc String tez-site

标签描述。

RequestId String EBB4D49C-4064-4818-B3AE-4C6BE5FC8264

请求ID。

示例

请求示例


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

正常返回示例

XML 格式

<DescribeClusterServiceConfigTagResponse>
	  <ConfigTagList>
		    <ConfigTag>
			      <ValueList>
				        <Value>
					          <ValueDesc>tez-site</ValueDesc>
					          <Value>tez-site</Value>
				        </Value>
			      </ValueList>
			      <TagDesc>所属文件</TagDesc>
			      <Tag>FILE_NAME</Tag>
		    </ConfigTag>
		    <ConfigTag>
			      <ValueList>
				        <Value>
					          <ValueDesc>基础配置</ValueDesc>
					          <Value>BASIC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>高级配置</ValueDesc>
					          <Value>ADVANCED</Value>
				        </Value>
				        <Value>
					          <ValueDesc>只读配置</ValueDesc>
					          <Value>INFORMATION</Value>
				        </Value>
				        <Value>
					          <ValueDesc>数据路径</ValueDesc>
					          <Value>DATA_PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>日志路径</ValueDesc>
					          <Value>LOG_PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>日志相关</ValueDesc>
					          <Value>LOG</Value>
				        </Value>
				        <Value>
					          <ValueDesc>JVM相关</ValueDesc>
					          <Value>JVM</Value>
				        </Value>
				        <Value>
					          <ValueDesc>数据相关</ValueDesc>
					          <Value>DATA</Value>
				        </Value>
				        <Value>
					          <ValueDesc>数据库相关</ValueDesc>
					          <Value>DATABASE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>性能相关</ValueDesc>
					          <Value>PERFORMANCE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>时间相关</ValueDesc>
					          <Value>TIME</Value>
				        </Value>
				        <Value>
					          <ValueDesc>编解码相关</ValueDesc>
					          <Value>CODEC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>OSS相关</ValueDesc>
					          <Value>OSS</Value>
				        </Value>
				        <Value>
					          <ValueDesc>地址端口</ValueDesc>
					          <Value>PORT</Value>
				        </Value>
				        <Value>
					          <ValueDesc>内存配置</ValueDesc>
					          <Value>MEMORY</Value>
				        </Value>
				        <Value>
					          <ValueDesc>磁盘相关</ValueDesc>
					          <Value>DISK</Value>
				        </Value>
				        <Value>
					          <ValueDesc>网络相关</ValueDesc>
					          <Value>NETWORK</Value>
				        </Value>
				        <Value>
					          <ValueDesc>文件路径</ValueDesc>
					          <Value>PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>URL或URI</ValueDesc>
					          <Value>URI</Value>
				        </Value>
			      </ValueList>
			      <TagDesc>配置类型</TagDesc>
			      <Tag>PROPERTY_TYPE</Tag>
		    </ConfigTag>
	  </ConfigTagList>
	  <RequestId>B887B2A3-E770-4340-A556-D9FAF41ABF47</RequestId>
</DescribeClusterServiceConfigTagResponse>

JSON 格式

{
	"RequestId":"B887B2A3-E770-4340-A556-D9FAF41ABF47",
	"ConfigTagList":{
		"ConfigTag":[
			{
				"Tag":"FILE_NAME",
				"TagDesc":"所属文件",
				"ValueList":{
					"Value":[
						{
							"Value":"tez-site",
							"ValueDesc":"tez-site"
						}
					]
				}
			},
			{
				"Tag":"PROPERTY_TYPE",
				"TagDesc":"配置类型",
				"ValueList":{
					"Value":[
						{
							"Value":"BASIC",
							"ValueDesc":"基础配置"
						},
						{
							"Value":"ADVANCED",
							"ValueDesc":"高级配置"
						},
						{
							"Value":"INFORMATION",
							"ValueDesc":"只读配置"
						},
						{
							"Value":"DATA_PATH",
							"ValueDesc":"数据路径"
						},
						{
							"Value":"LOG_PATH",
							"ValueDesc":"日志路径"
						},
						{
							"Value":"LOG",
							"ValueDesc":"日志相关"
						},
						{
							"Value":"JVM",
							"ValueDesc":"JVM相关"
						},
						{
							"Value":"DATA",
							"ValueDesc":"数据相关"
						},
						{
							"Value":"DATABASE",
							"ValueDesc":"数据库相关"
						},
						{
							"Value":"PERFORMANCE",
							"ValueDesc":"性能相关"
						},
						{
							"Value":"TIME",
							"ValueDesc":"时间相关"
						},
						{
							"Value":"CODEC",
							"ValueDesc":"编解码相关"
						},
						{
							"Value":"OSS",
							"ValueDesc":"OSS相关"
						},
						{
							"Value":"PORT",
							"ValueDesc":"地址端口"
						},
						{
							"Value":"MEMORY",
							"ValueDesc":"内存配置"
						},
						{
							"Value":"DISK",
							"ValueDesc":"磁盘相关"
						},
						{
							"Value":"NETWORK",
							"ValueDesc":"网络相关"
						},
						{
							"Value":"PATH",
							"ValueDesc":"文件路径"
						},
						{
							"Value":"URI",
							"ValueDesc":"URL或URI"
						}
					]
				}
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
403 Params.Illegal The specified parameters are wrongly formed.. 指定参数格式错误
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource 不能操作其它用户的资源
403 Invalid.Cluster.Status Invalid cluster status %s in status list 指定集群状态不合法
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list 指定集群类型不合法
404 ClusterId.NotFound The ClusterId provided does not exist in our records. Cluster Id不存在,确认集群的Cluster Id
500 InternalError The request processing has failed due to some unknown error. 内部错误,请提工单

访问错误中心查看更多错误码。