この操作を呼び出して、リソースプールを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この API は、OpenAPI Explorerで呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 必須 ListResourcePool

実行する操作。 値を ListResourcePool に設定します。
ClusterId String 必須 C-EBD62A703A43****

クラスターの ID。
RegionId String 必須 cn-hangzhou

クラスターが属するリージョンの ID。
AccessKeyId String 任意 LTAI8ljWyu7y****

Alibaba Cloud から提供された AccessKey ID。 このパラメーターでユーザーを識別します。
PageNumber Integer 任意 100

返されるページのページ番号。
PageSize Integer 任意 50

返される 1 ページ当たりのエントリ数。
PoolType String 任意 CAPACITY_SCHEDULER

リソースプールのスケジューラータイプ。 有効な値：CAPACITY_SCHEDULER および FAIR_SCHEDULER。

レスポンスパラメーター

パラメーター データ型 例 説明
PageNumber Integer 1

返されたページのページ番号。
PageSize Integer 20

返された 1 ページ当たりのエントリ数。
PoolInfoList

クラスターのリソースプールのリスト。
PoolInfo

クラスターのリソースプール。
EcmResourcePool

リソースプールの基本情報。
Active Boolean true

リソースプールがアクティブな状態かどうか。
Id Long 116

リソースグループの ID 。
Name String DEFAULT

リソースプールの名前。
Note String test

リソースプールの説明。
PoolType String CAPACITY_SCHEDULER

リソースプールのスケジューラータイプ。
UserId String 1528342356764****

ユーザーの ID。
YarnSiteConfig String null

yarn-site.xml ファイルの設定。
EcmResourcePoolConfigList

リソースプールの設定パラメーター。
EcmResourcePoolConfig

リソースプールの設定パラメーターの情報。
Category String QUEUE_RESOURCE_LIMIT

パラメーターのカテゴリ。
ConfigKey String minimum-user-limit-percent

パラメーターのキー。
ConfigType String RESOURCE_QUEUE_CONFIG

パラメーターのタイプ。
ConfigValue String 0

パラメーターの値。
Id Long 2926

パラメーターの ID。
Note String test

パラメーターの説明。
Status String NORMAL

パラメーターの状態。
QueueList

リソースプールのキュー。
Queue

リソースプールのキューの情報。
EcmResourcePoolConfigList

リソースプールの設定パラメーター。
EcmResourcePoolConfig

リソースプールの設定パラメーターの情報。
Category String QUEUE_RESOURCE_LIMIT

パラメーターのカテゴリ。
ConfigKey String minimum-user-limit-percent

パラメーターのキー。
ConfigType String RESOURCE_QUEUE_CONFIG

パラメーターのタイプ。
ConfigValue String 0

パラメーターの値。
Id Long 2926

パラメーターの ID。
Note String test

パラメーターの説明。
Status String NORMAL

パラメーターの状態。
EcmResourceQueue

リソースプールのキュー。
Id Long 2928

キューの名前。
Leaf Boolean false

キューがリーフキューかどうか。
Name String DEFAULT2

キューの名前。
ParentQueueId Long 116

親キューの ID。
QualifiedName String default

修飾名。
QueueType String null

キューのタイプ。
ResourcePoolId Long 116

リソースプールの ID。
Status String NORMAL

スケジュールの状態。
UserId String 1528342356764****

ユーザーの ID。
RequestId String A544317F-4A60-4532-AC96-191B9D80420A

リクエストの ID。
Total Integer 10

返されたエントリの総数。

例

リクエストの例


http(s)://[Endpoint]/? Action=ListResourcePool
&ClusterId=C-EBD62A703A430E23
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<ListResourcePoolResponse>
	  <Data>
		    <PoolInfoList>
			      <PoolInfo>
				        <EcmResourcePoolConfigList></EcmResourcePoolConfigList>
				        <EcmResourcePool>
					          <Name>DEFAULT</Name>
					          <YarnSiteConfig></YarnSiteConfig>
					          <PoolType>CAPACITY_SCHEDULER</PoolType>
					          <Active>true</Active>
					          <Id>116</Id>
					          <Note></Note>
					          <UserId>152834231764****</UserId>
				        </EcmResourcePool>
				        <QueueList>
					          <Queue>
						            <EcmResourcePoolConfigList>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>capacity</ConfigKey>
								                <ConfigValue>100</ConfigValue>
								                <Id>2925</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>minimum-user-limit-percent</ConfigKey>
								                <ConfigValue>0</ConfigValue>
								                <Id>2926</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-capacity</ConfigKey>
								                <ConfigValue>0</ConfigValue>
								                <Id>2927</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>user-limit-factor</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2928</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-allocation-mb</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2929</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-allocation-vcores</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2930</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-applications</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2931</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-am-resource-percent</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2932</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>state</ConfigKey>
								                <ConfigValue>RUNNING</ConfigValue>
								                <Id>2933</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_SUBMISSION_ACCESS_CONTROL</Category>
								                <ConfigKey>acl_submit_applications</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2934</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_ADMINISTRATION_ACCESS_CONTROL</Category>
								                <ConfigKey>acl_administer_queue</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2935</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
						            </EcmResourcePoolConfigList>
						            <EcmResourceQueue>
							              <Name>default</Name>
							              <Status>NORMAL</Status>
							              <QualifiedName>default</QualifiedName>
							              <Id>247</Id>
							              <QueueType></QueueType>
							              <ResourcePoolId>116</ResourcePoolId>
							              <UserId>152834231764****</UserId>
							              <Leaf>false</Leaf>
							              <ParentQueueId>0</ParentQueueId>
						            </EcmResourceQueue>
					          </Queue>
				        </QueueList>
			      </PoolInfo>
			      <PoolInfo>
				        <EcmResourcePoolConfigList></EcmResourcePoolConfigList>
				        <EcmResourcePool>
					          <Name>pool1</Name>
					          <YarnSiteConfig></YarnSiteConfig>
					          <PoolType>CAPACITY_SCHEDULER</PoolType>
					          <Active>true</Active>
					          <Id>117</Id>
					          <Note></Note>
					          <UserId>152834231764****</UserId>
				        </EcmResourcePool>
				        <QueueList></QueueList>
			      </PoolInfo>
		    </PoolInfoList>
		    <RequestId>213DD361-EF38-4A31-A909-96857AEE42DE</RequestId>
	  </data>
	  <requestId>213DD361-EF38-4A31-A909-96857AEE42DE</requestId>
</ListResourcePoolResponse>

JSON 形式 

{
	"requestId":"213DD361-EF38-4A31-A909-96857AEE42DE",
	"data":{
		"PoolInfoList":{
			"PoolInfo":[
				{
					"EcmResourcePoolConfigList":{
						"EcmResourcePoolConfig":[]
					},
					"EcmResourcePool":{
						"YarnSiteConfig":"",
						"Name":"DEFAULT",
						"Active":true,
						"PoolType":"CAPACITY_SCHEDULER",
						"Note":"",
						"Id":116,
						"UserId":"152834231764****"
					},
					"QueueList":{
						"Queue":[
							{
								"EcmResourcePoolConfigList":{
									"EcmResourcePoolConfig":[
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"capacity",
											"ConfigValue":"100",
											"Note":"",
											"Id":2925,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"minimum-user-limit-percent",
											"ConfigValue":"0",
											"Note":"",
											"Id":2926,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-capacity",
											"ConfigValue":"0",
											"Note":"",
											"Id":2927,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"user-limit-factor",
											"ConfigValue":""
											"Note":"",
											"Id":2928,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-allocation-mb",
											"ConfigValue":"",
											"Note":"",
											"Id":2929,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-allocation-vcores",
											"ConfigValue":""
											"Note":"",
											"Id":2930,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-applications",
											"ConfigValue":"",
											"Note":"",
											"Id":2931,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-am-resource-percent",
											"ConfigValue":"",
											"Note":"",
											"Id":2932,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"state",
											"ConfigValue":"RUNNING",
											"Note":"",
											"Id":2933,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_SUBMISSION_ACCESS_CONTROL",
											"ConfigKey":"acl_submit_applications",
											"ConfigValue":"",
											"Note":"",
											"Id":2934,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_ADMINISTRATION_ACCESS_CONTROL",
											"ConfigKey":"acl_administer_queue",
											"ConfigValue":""
											"Note":"",
											"Id":2935,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										}
									]
								},
								"EcmResourceQueue":{
									"Name":"default",
									"Status":"NORMAL",
									"QualifiedName":"default",
									"ResourcePoolId":116,
									"QueueType":"",
									"Id":247,
									"UserId":"152834231764****",
									"Leaf":false,
									"ParentQueueId":0
								}
							}
						]
					}
				},
				{
					"EcmResourcePoolConfigList":{
						"EcmResourcePoolConfig":[]
					},
					"EcmResourcePool":{
						"YarnSiteConfig":"",
						"Name":"pool1",
						"Active":true,
						"PoolType":"CAPACITY_SCHEDULER",
						"Note":"",
						"Id":117,
						"UserId":"152834231764****"
					},
					"QueueList":{
						"Queue":[]
					}
				}
			]
		},
		"RequestId":"213DD361-EF38-4A31-A909-96857AEE42DE"
	}
}

エラーコード

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. 指定されたクラスターのタイプが無効の場合に返されるエラーメッセージ。
500 InternalError The request processing has failed due to some unknown error. 内部エラーのためにリクエスト処理が失敗した場合に返されるエラーメッセージ。 チケットを起票し、サポートセンターにお問い合わせください。

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