すべてのプロダクト
Search
ドキュメントセンター

:GetSessionCluster

最終更新日:Dec 22, 2025

セッションの詳細を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは 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

ジョブの状態。

  • Starting:ジョブは開始中です。

  • Running:ジョブは実行中です。

  • Stopping:ジョブは停止中です。

  • Stopped:ジョブは停止しました。

  • Error:ジョブは失敗しました。

Running

stateChangeReason

object

状態変更の理由。

code

string

状態変更コード。

1000000

message

string

状態変更メッセージ。

ok

autoStartConfiguration

object

自動開始設定。

enable

boolean

自動開始を有効にするかどうかを指定します。

  • true:自動開始は有効です。

  • false:自動開始は無効です。

false

autoStopConfiguration

object

自動停止設定。

enable

boolean

自動停止を有効にするかどうかを指定します。

  • true:自動停止は有効です。

  • false:自動停止は無効です。

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

ジョブのタイプ。このパラメーターは必須であり、ジョブの作成後は変更できません。

  • SQLSCRIPT:SQL ジョブ。

  • JAR:JAR ジョブ。

  • PYTHON:Python ジョブ。

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****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。