获取会话列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
emr-serverless-spark:ListSessionClusters |
list |
*全部资源
|
无 | 无 |
请求语法
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 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 |
会话类型。 枚举值：
|
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 |
integer |
创建时间。 |
1732267598000 |
| startTime |
integer |
启动时间。 |
1732267598000 |
| domainInner |
string |
Thrift server 的内网域名。 |
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 |
示例
正常返回示例
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",
"extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
"publicEndpointEnabled": true,
"connectionToken": ""
}
],
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"nextToken": "1",
"maxResults": 20,
"totalCount": 200
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。