セッションクラスターのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
emr-serverless-spark:ListSessionClusters |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v1/workspaces/{workspaceId}/sessionClusters HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| workspaceId |
string |
任意 |
ワークスペース ID。 |
w-1234abcd |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| nextToken |
string |
任意 |
次のページの結果の開始位置を示すトークン。 |
1 |
| maxResults |
integer |
任意 |
返すレコードの最大数。 |
20 |
| sessionClusterId |
string |
任意 |
ジョブの名前。 |
emr-spark-demo-job |
| queueName |
string |
任意 |
キュー名。 |
root |
| kind |
string |
任意 |
セッションタイプ。 列挙値:
|
SQL |
| regionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されたデータ。 |
||
| sessionClusters |
array<object> |
セッションのリスト。 |
|
|
array<object> |
セッションの詳細。 |
||
| workspaceId |
string |
ワークスペース ID。 |
w-1234abcd |
| sessionClusterId |
string |
セッション ID。 |
sc-123131 |
| userId |
string |
ユーザー ID。 |
123131 |
| queueName |
string |
セッションが実行されるキューの名前。 |
dev_queue |
| state |
string |
セッションの状態。
|
Running |
| stateChangeReason |
object |
セッションの最後の状態変更の詳細。 |
|
| code |
string |
状態変更コード。 |
200 |
| message |
string |
状態変更メッセージ。 |
ok |
| autoStartConfiguration |
object |
自動開始構成。 |
|
| enable |
boolean |
自動開始が有効になっているかどうかを示します。 |
true |
| autoStopConfiguration |
object |
自動停止構成。 |
|
| enable |
boolean |
自動停止が有効になっているかどうかを示します。 |
false |
| idleTimeoutMinutes |
integer |
セッションが自動的に停止されるまでの非アクティブな時間 (分)。 |
45 |
| applicationConfigs |
array<object> |
セッション構成。基盤となる Spark ジョブの構成に相当します。 |
|
|
object |
SQL Compute の構成です。これは、基盤となる Spark ジョブの構成と同等です。 |
||
| configFileName |
string |
構成ファイル名。 |
spark-default.conf |
| configItemKey |
string |
構成キー。 |
spark.app.name |
| configItemValue |
string |
構成値。 |
test_application |
| name |
string |
セッション名。 |
adhoc_query |
| userName |
string |
ユーザー名。 |
test_user |
| kind |
string |
セッションタイプ。 列挙値:
|
SQL |
| webUI |
string |
セッションの Spark UI の URL。 |
http://spark-ui-xxxx |
| releaseVersion |
string |
Serverless Spark のバージョン。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| draftId |
string |
セッションにアタッチされている開発者ジョブの ID。 |
TSK-xxxxxxxxx |
| domain |
string |
Thrift サーバーのパブリックエンドポイント。 |
emr-spark-gateway-cn-hangzhou.data.aliyun.com |
| displayReleaseVersion |
string |
コンソールに表示されるバージョン。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| fusion |
boolean |
Fusion エンジンによるアクセラレーションが有効になっているかどうかを示します。 |
false |
| gmtCreate |
integer |
セッションが作成された時間。 |
1732267598000 |
| startTime |
integer |
セッションが開始された時間。 |
1732267598000 |
| domainInner |
string |
Thrift サーバーの内部の同一リージョンエンドポイント。 |
emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com |
| extra |
string |
セッションの追加メタデータ。 |
{"extraInfoKey":"extraInfoValue"} |
| publicEndpointEnabled |
boolean |
||
| connectionToken |
string |
||
| requestId |
string |
リクエスト ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944**** |
| nextToken |
string |
次のページの結果の開始位置を示すトークン。 |
1 |
| maxResults |
integer |
リクエストに対して返されるエントリの最大数。 |
20 |
| totalCount |
integer |
クエリ条件に一致するエントリの総数。 |
200 |
例
成功レスポンス
JSONJSON
{
"sessionClusters": [
{
"workspaceId": "w-1234abcd",
"sessionClusterId": "sc-123131",
"userId": "123131",
"queueName": "dev_queue",
"state": "Running",
"stateChangeReason": {
"code": "200",
"message": "ok"
},
"autoStartConfiguration": {
"enable": true
},
"autoStopConfiguration": {
"enable": false,
"idleTimeoutMinutes": 45
},
"applicationConfigs": [
{
"configFileName": "spark-default.conf",
"configItemKey": "spark.app.name",
"configItemValue": "test_application"
}
],
"name": "adhoc_query",
"userName": "test_user",
"kind": "SQL",
"webUI": "http://spark-ui-xxxx",
"releaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
"draftId": "TSK-xxxxxxxxx\n",
"domain": "emr-spark-gateway-cn-hangzhou.data.aliyun.com",
"displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
"fusion": false,
"gmtCreate": 1732267598000,
"startTime": 1732267598000,
"domainInner": "emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com",
"extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
"publicEndpointEnabled": false,
"connectionToken": ""
}
],
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"nextToken": "1",
"maxResults": 20,
"totalCount": 200
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。