获取会话详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
emr-serverless-spark:GetSessionCluster |
get |
*全部资源
|
无 | 无 |
请求语法
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 链接地址。 |
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**** |
示例
正常返回示例
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",
"extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
"publicEndpointEnabled": true,
"connectionToken": ""
},
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。