GetSessionCluster - 获取会话详情

获取会话详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr-serverless-spark:GetSessionClusterget
*全部资源
*

请求语法

GET /api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId} HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

工作空间 ID。

w-1234abcd
sessionClusterIdstring

作业名称。

emr-spark-demo-job
regionIdstring

区域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回数据。

sessionClusterobject

会话对象。

workspaceIdstring

工作空间 ID。

w-1234abcd
sessionClusterIdstring

交互式作业会话 ID。

1234abcd-12ab-34cd-56ef-1234567890ab
userIdstring

用户 ID。

123xxxxxxxx
queueNamestring

队列名称。

dev_queue
statestring

作业状态。

  • Starting:启动中。
  • Running:运行中。
  • Stopping:正在停止。
  • Stopped:已停止。
  • Error:已失败。
Running
stateChangeReasonobject

状态变化原因。

codestring

状态变化编码。

1000000
messagestring

状态变化消息。

ok
autoStartConfigurationobject

是否开启自动启动。

enableboolean

是否开启自动启动。

  • true:是。
  • false:否。
false
autoStopConfigurationobject

是否允许自动终止。

enableboolean

是否允许自动终止。

  • true:是。
  • false:否。
false
idleTimeoutMinutesinteger

会话空闲指定分钟数后自动终止。

60
applicationConfigsarray<object>

Spark 应用配置列表。

applicationConfigobject

Spark 应用配置。

configFileNamestring

配置文件名。

spark-defaults.conf
configItemKeystring

配置键。

spark.app.name
configItemValuestring

配置值。

test
releaseVersionstring

Serverless Spark 版本。

esr-4.0.0 (Spark 3.5.2, Scala 2.12)
namestring

会话名称。

test
userNamestring

会话创建者名称。

user1
kindstring

生效作业类型,必填,创建后无法修改。

  • SQLSCRIPT:SQL 作业。
  • JAR:JAR 作业。
  • PYTHON:Python 作业。
SQL
webUIstring

会话 Spark UI 链接地址。

https://spark-ui/link
draftIdstring

会话绑定的开发作业 ID。

TSK-xxxxxxxx
domainstring

会话 Spark UI 所属域。

your.domain.com
displayReleaseVersionstring

控制台实际展示的版本。

esr-4.0.0 (Spark 3.5.2, Scala 2.12)
fusionboolean

是否开启 Fusion 引擎加速。

false
envIdstring

环境 ID。

env-cpv569tlhtgndjl8****
gmtCreatelong

创建时间。

2024-09-01 06:23:01
startTimelong

开始时间。

2024-09-01 06:23:01
domainInnerstring

内网域名。

emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com
requestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****

示例

正常返回示例

JSON格式

{
  "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"
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

错误码

访问错误中心查看更多错误码。