文档

ListSessionClusters - 获取SQL Compute列表

更新时间:

调试

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

授权信息

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

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

请求语法

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

请求参数

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

标记当前开始读取的位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
maxResultsinteger

一次获取的最大记录数。

20
workspaceIdstring

工作空间 id。

w-1234abcd
sessionClusterIdstring

作业名称。

emr-spark-demo-job
queueNamestring

队列名称。

root
regionIdstring

区域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回数据

sessionClustersarray<object>

SQL Compute 列表

object

SQL Compute 详情

workspaceIdstring

工作空间 id。

w-1234abcd
sessionClusterIdstring

SQL Compute id

sc-123131
userIdstring

用户 id

123131
queueNamestring

SQL Compute 运行队列名称

dev_queue
statestring

SQL Compute 状态

Running
stateChangeReasonobject

SQL Compute 最近一次状态变化详情

codestring

状态变化编码

200
messagestring

状态变化消息

ok
autoStartConfigurationobject

自动启动配置

enableboolean

是否开启自动启动

true
autoStopConfigurationobject

自动终止配置

enableboolean

是否允许自动终止

false
idleTimeoutMinutesinteger

SQL Compute 空闲指定分钟数后自动终止

45
applicationConfigsarray<object>

SQL Compute 配置,等价于背后运行的 spark job 的配置

object
configFileNamestring

配置文件名

spark-default.conf
configItemKeystring

配置键

spark.app.name
configItemValuestring

配置值

test_application
namestring

SQL Compute 名称

adhoc_query
userNamestring

用户名

test_user
requestIdstring

请求 ID。

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

返回读取到的数据位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
maxResultsinteger

本次请求所返回的最大记录条数。

20
totalCountinteger

本次请求条件下的数据总量。

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": "",
      "webUI": "",
      "releaseVersion": "",
      "draftId": "",
      "domain": ""
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "maxResults": 20,
  "totalCount": 200
}

错误码

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

变更历史

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