ListSessionClusters - 获取会话列表_开源大数据平台 E-MapReduce(EMR)-阿里云帮助中心

获取会话列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
emr-serverless-spark:ListSessionClusters	list	全部资源 ``	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
nextToken	string	否	标记当前开始读取的位置。	1
maxResults	integer	否	一次获取的最大记录数。	20
workspaceId	string	否	工作空间 ID。	w-1234abcd
sessionClusterId	string	否	作业名称。	emr-spark-demo-job
queueName	string	否	队列名称。	root
kind	string	否	会话类型。枚举值： NOTEBOOK：NOTEBOOK。 THRIFT：THRIFT。 SQL：SQL。	SQL
regionId	string	否	区域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	返回数据。
sessionClusters	array<object>	会话列表。
SessionCluster	object	会话详情。
workspaceId	string	工作空间 ID。	w-1234abcd
sessionClusterId	string	会话 ID。	sc-123131
userId	string	用户 ID。	123131
queueName	string	会话运行队列名称。	dev_queue
state	string	会话状态。 Starting：启动中。 Running：运行中。 Stopping：正在停止。 Stopped：已停止。 Error：已失败。	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 作业的配置。
ApplicationConfig	object	SQL Compute 配置，等价于背后运行的 spark job 的配置。
configFileName	string	配置文件名。	spark-default.conf
configItemKey	string	配置键。	spark.app.name
configItemValue	string	配置值。	test_application
name	string	会话名称。	adhoc_query
userName	string	用户名。	test_user
kind	string	会话类型。枚举值： NOTEBOOK：NOTEBOOK。 THRIFT：THRIFT。 SQL：SQL。	SQL
webUI	string	会话 SparkUI 链接地址。	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 server 的外网域名。	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	long	创建时间。	1732267598000
startTime	long	启动时间。	1732267598000
domainInner	string	Thrift server 的内网域名。	emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com
requestId	string	请求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	返回读取到的数据位置。	1
maxResults	integer	本次请求所返回的最大记录条数。	20
totalCount	integer	本次请求条件下的数据总量。	200

示例

正常返回示例

JSON格式

{
  "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"
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-20	OpenAPI 返回结构发生变更	查看变更详情
2024-07-09	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情