DescribeClusterServiceConfigTag - - Alibaba Cloud ドキュメントセンター

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター


パラメーター	データ型	必須／任意	例	説明
Action	String	必須	DescribeClusterServiceConfigTag	実行する操作。値を DescribeClusterServiceConfigTag に設定します。
ClusterId	String	必須	C-F32FB31D8295 ****	クラスターの ID。
RegionId	String	必須	cn-hangzhou	クラスターが属するリージョンの ID。
ServiceName	String	必須	TEZ	サービスの名前。
ConfigTag	String	任意	FILE_NAME	タグの名前。
AccessKeyId	String	任意	LTAI8ljWyu7y****	Alibaba Cloud から提供された AccessKey ID。このパラメーターはユーザーを識別します。

レスポンスパラメーター


パラメーター	データ型	例	説明
ConfigTagList			タグのリスト。
ConfigTag			タグの情報。
Tag	String	FILE_NAME	タグの名前。
TagDesc	String	The file to which the tag is attached	タグの説明を入力。
ValueList			タグ値のリスト。
Value			タグ値の情報。
Value	String	tez-site	タグの値。
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>The file to which the tag is attached</TagDesc>
			      <Tag>FILE_NAME</Tag>
		    </ConfigTag>
		    <ConfigTag>
			      <ValueList>
				        <Value>
					          <ValueDesc>basic configurations</ValueDesc>
					          <Value>BASIC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>advanced configurations</ValueDesc>
					          <Value>ADVANCED</Value>
				        </Value>
				        <Value>
					          <ValueDesc>read-only configurations</ValueDesc>
					          <Value>INFORMATION</Value>
				        </Value>
				        <Value>
					          <ValueDesc>data path</ValueDesc>
					          <Value>DATA_PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>log path</ValueDesc>
					          <Value>LOG_PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>log</ValueDesc>
					          <Value>LOG</Value>
				        </Value>
				        <Value>
					          <ValueDesc>JVM</ValueDesc>
					          <Value>JVM</Value>
				        </Value>
				        <Value>
					          <ValueDesc>data</ValueDesc>
					          <Value>DATA</Value>
				        </Value>
				        <Value>
					          <ValueDesc>database</ValueDesc>
					          <Value>DATABASE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>performance</ValueDesc>
					          <Value>PERFORMANCE</Value>
				        </Value>
				        <Value>
					          <ValueDesc>time</ValueDesc>
					          <Value>TIME</Value>
				        </Value>
				        <Value>
					          <ValueDesc>coding and decoding</ValueDesc>
					          <Value>CODEC</Value>
				        </Value>
				        <Value>
					          <ValueDesc>OSS</ValueDesc>
					          <Value>OSS</Value>
				        </Value>
				        <Value>
					          <ValueDesc>port address</ValueDesc>
					          <Value>PORT</Value>
				        </Value>
				        <Value>
					          <ValueDesc>memory configurations</ValueDesc>
					          <Value>MEMORY</Value>
				        </Value>
				        <Value>
					          <ValueDesc>disk</ValueDesc>
					          <Value>DISK</Value>
				        </Value>
				        <Value>
					          <ValueDesc>network</ValueDesc>
					          <Value>NETWORK</Value>
				        </Value>
				        <Value>
					          <ValueDesc>file path</ValueDesc>
					          <Value>PATH</Value>
				        </Value>
				        <Value>
					          <ValueDesc>URL or URI</ValueDesc>
					          <Value>URI</Value>
				        </Value>
			      </ValueList>
			      <TagDesc>configuration type</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":"The tag is attached to a configuration file",
				"ValueList":{
					"Value":[
						{
							"Value":"tez-site",
							"ValueDesc":"tez-site"
						}
					]
				}
			},
			{
				"Tag":"PROPERTY_TYPE",
				"TagDesc":"configuration type",
				"ValueList":{
					"Value":[
						{
							"Value":"BASIC",
							"ValueDesc":"basic configurations"
						},
						{
							"Value":"ADVANCED",
							"ValueDesc":"advanced configurations"
						},
						{
							"Value":"INFORMATION",
							"ValueDesc":"read-only configurations"
						},
						{
							"Value":"DATA_PATH",
							"ValueDesc":"data path"
						},
						{
							"Value":"LOG_PATH",
							"ValueDesc":"log path"
						},
						{
							"Value":"LOG",
							"ValueDesc":"log"
						},
						{
							"Value":"JVM",
							"ValueDesc":"JVM"
						},
						{
							"Value":"DATA",
							"ValueDesc":"data"
						},
						{
							"Value":"DATABASE",
							"ValueDesc":"database"
						},
						{
							"Value":"PERFORMANCE",
							"ValueDesc":"performance"
						},
						{
							"Value":"TIME",
							"ValueDesc":"time"
						},
						{
							"Value":"CODEC",
							"ValueDesc":"coding and decoding"
						},
						{
							"Value":"OSS",
							"ValueDesc":"OSS"
						},
						{
							"Value":"PORT",
							"ValueDesc":"port address"
						},
						{
							"Value":"MEMORY",
							"ValueDesc":"memory configurations"
						},
						{
							"Value":"DISK",
							"ValueDesc": "disk"
						},
						{
							"Value":"NETWORK",
							"ValueDesc":"network"
						},
						{
							"Value":"PATH",
							"ValueDesc":"file path"
						},
						{
							"Value":"URI",
							"ValueDesc":"URL or URI"
						}
					]
				}
			}
		]
	}
}

エラーコード


HTTP ステータスコード	エラーコード	エラーメッセージ	操作
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.	指定された ClusterId パラメーターが存在しない場合に返されるエラーメッセージ。クラスターの ID が有効であるか確認してください。
500	InternalError	The request processing has failed due to some unknown error.	内部エラーによりリクエスト処理が失敗した場合に返されるエラーメッセージ。チケットを起票してください。

エラーコードについては、「API エラーセンター」をご参照ください。