セッションの詳細を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
emr-serverless-spark:GetSessionCluster |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| workspaceId |
string |
任意 |
ワークスペース ID。 |
w-1234abcd |
| sessionClusterId |
string |
任意 |
ジョブ名。 |
emr-spark-demo-job |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| regionId |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータ。 |
||
| sessionCluster |
object |
セッションオブジェクト。 |
|
| workspaceId |
string |
ワークスペース ID。 |
w-1234abcd |
| sessionClusterId |
string |
セッションクラスター ID。 |
1234abcd-12ab-34cd-56ef-1234567890ab |
| userId |
string |
ユーザー ID。 |
123xxxxxxxx |
| queueName |
string |
キュー名。 |
dev_queue |
| state |
string |
ジョブの状態。
|
Running |
| stateChangeReason |
object |
状態変更の理由。 |
|
| code |
string |
状態変更コード。 |
1000000 |
| message |
string |
状態変更メッセージ。 |
ok |
| autoStartConfiguration |
object |
自動開始設定。 |
|
| enable |
boolean |
自動開始を有効にするかどうかを指定します。
|
false |
| autoStopConfiguration |
object |
自動停止設定。 |
|
| enable |
boolean |
自動停止を有効にするかどうかを指定します。
|
false |
| idleTimeoutMinutes |
integer |
セッションが自動的に停止されるまでのアイドル状態の許容時間 (分)。 |
60 |
| applicationConfigs |
array<object> |
Spark アプリケーション設定のリスト。 |
|
|
object |
Spark アプリケーション設定。 |
||
| configFileName |
string |
設定ファイルの名前。 |
spark-defaults.conf |
| configItemKey |
string |
設定キー。 |
spark.app.name |
| configItemValue |
string |
設定値。 |
test |
| releaseVersion |
string |
Serverless Spark のバージョン。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| name |
string |
セッション名。 |
test |
| userName |
string |
セッションを作成したユーザーの名前。 |
user1 |
| kind |
string |
ジョブのタイプ。このパラメーターは必須であり、ジョブの作成後は変更できません。
|
SQL |
| webUI |
string |
セッションの Spark UI の URL。 |
https://spark-ui/link |
| draftId |
string |
セッションにアタッチされている開発者ジョブの ID。 |
TSK-xxxxxxxx |
| domain |
string |
セッションの Spark UI のドメイン名。 |
your.domain.com |
| displayReleaseVersion |
string |
コンソールに表示されるバージョン。 |
esr-4.0.0 (Spark 3.5.2, Scala 2.12) |
| fusion |
boolean |
Fusion エンジンを使用したアクセラレーションを有効にするかどうかを指定します。 |
false |
| envId |
string |
環境 ID。 |
env-cpv569tlhtgndjl8**** |
| gmtCreate |
integer |
セッションが作成された時間。 |
2024-09-01 06:23:01 |
| startTime |
integer |
セッションが開始された時間。 |
2024-09-01 06:23:01 |
| domainInner |
string |
内部の同一リージョンエンドポイント。 |
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**** |
例
成功レスポンス
JSONJSON
{
"sessionCluster": {
"workspaceId": "w-1234abcd",
"sessionClusterId": "1234abcd-12ab-34cd-56ef-1234567890ab",
"userId": "123xxxxxxxx",
"queueName": "dev_queue",
"state": "Running",
"stateChangeReason": {
"code": "1000000",
"message": "ok"
},
"autoStartConfiguration": {
"enable": false
},
"autoStopConfiguration": {
"enable": false,
"idleTimeoutMinutes": 60
},
"applicationConfigs": [
{
"configFileName": "spark-defaults.conf",
"configItemKey": "spark.app.name",
"configItemValue": "test"
}
],
"releaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
"name": "test",
"userName": "user1",
"kind": "SQL",
"webUI": "https://spark-ui/link",
"draftId": "TSK-xxxxxxxx",
"domain": "your.domain.com",
"displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
"fusion": false,
"envId": "env-cpv569tlhtgndjl8****",
"gmtCreate": 0,
"startTime": 0,
"domainInner": "emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com",
"extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
"publicEndpointEnabled": false,
"connectionToken": ""
},
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。