文档首页/ 智能数据湖 AI DataLake/ API参考/ Aura相关API/ AuraSQL作业管理/ 创建Session - CreateAuraV2SqlSession
更新时间：2026-10-19 GMT+08:00
查看PDF
分享

创建Session - CreateAuraV2SqlSession

功能介绍

创建SQL Session。

此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

POST /v2/workspaces/{workspace_id}/aura-sessions

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间的ID。获取方法请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

endpoint_name

是

String

参数解释：端点名称。

约束限制：不涉及。

取值范围：长度为1~128个字符，支持大小写英文字母、数字、点号、中文、下划线、连字符、空格。

默认取值：不涉及。

agency_name

否

String

参数解释：委托名称。

约束限制：具体请参见配置Aura委托。

取值范围：不涉及。

默认取值：不涉及。

catalog_context

是

CatalogContext object

参数解释：LakeFormation相关信息。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

wait_timeout

否

Integer

参数解释：创建Session排队等待时间，单位：秒。

约束限制：不涉及。

取值范围：300~86400。

默认取值：不涉及。

max_retry_times

否

Integer

参数解释：资源不足时重试次数。

约束限制：不涉及。

取值范围：1~2147483647。

默认取值：不涉及。

priority

否

Integer

参数解释：优先级（1~9，9为最高优先级）。

约束限制：不涉及。

取值范围：1~9。

默认取值：5。

cpu

否

Long

参数解释：会话维度指定的 CN（计算节点）CPU 资源规格，单位：毫核（millicores）。

约束限制：可选；不传时回退到全局配置 getCnCpuLimit；

INNER_SESSION/维护语句场景不消费该字段，资源规格继承父会话 CN；

上限 48000 毫核（48 核），超上限返回 400 INVALID_PARAMETER。

取值范围：1~48000毫核。

默认取值：不传时取全局配置兜底值（如 4000 毫核）。

memory

否

Long

参数解释：会话维度指定的 CN（计算节点）Memory 资源规格，单位：MB。

约束限制：可选；不传时回退到全局配置 getCnMemoryLimit；

INNER_SESSION/维护语句场景不消费该字段，资源规格继承父会话 CN；

上限 393216MB（384 GB），超上限返回 400 INVALID_PARAMETER。

取值范围：1~393216MB。

默认取值：不传时取全局配置兜底值（如 16384 MB）。
表4 CatalogContext

参数

是否必选

参数类型

描述

catalog_name

是

String

参数解释：LakeFormation的catalogName。

约束限制：不涉及。

取值范围：长度为1~255个字符，支持大小写英文字母、数字、连字符。

默认取值：不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

session_id

String

参数解释：Session的ID。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

status

String

参数解释：Session的状态。

取值范围：

  • RUNNING：运行中。

  • CLOSED：已关闭。

  • WAITING：等待中。

  • CREATING：创建中。

  • FAIL：失败。

cpu

Integer

参数解释：CPU资源大小（毫核）。

memory

Integer

参数解释：内存资源大小（MB）。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：408

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

请求示例

在指定workspace和endpoint下创建SQL Session的请求示例。

POST /v2/workspaces/{workspace_id}/aura-sessions

{
  "endpoint_name" : "aura-endpoint",
  "catalog_context" : {
    "catalog_name" : "catalog_default"
  }
}

响应示例

状态码：200

{
  "session_id" : "ac8111bf-3601-xxxx-xxxx-b41d3e636a4e",
  "status" : "RUNNING"
}

状态码：400

{
  "error_code" : "AIDataLake.00092031",
  "error_msg" : "Invalid parameter name",
  "solution_msg" : "Please enter parameters in the correct format."
}

状态码：401

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed",
  "solution_msg" : "Please obtain a valid token and retry."
}

状态码：403

{
  "error_code" : "AIDataLake.00090030",
  "error_msg" : "Unauthorized requests.",
  "solution_msg" : "Check permissions and retry after authorization."
}

状态码：404

{
  "error_code" : "AIDataLake.00090009",
  "error_msg" : "The resource does not exist.",
  "solution_msg" : "Please try to use correct info."
}

状态码：408

{
  "error_code" : "common.00000408",
  "error_msg" : "A timeout exception occurred.",
  "solution_msg" : "The request timed out while waiting for a response — check the backend service status and network, then retry; if the operation is long-running, increase the client timeout or split the request."
}

状态码：500

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error",
  "solution_msg" : "An internal service error occurred. Please retry later; if the problem persists, contact technical support."
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

401

未经授权。

403

请求被拒绝访问。

404

所请求的资源不存在。

408

请求超时。

500

服务器内部错误。
父主题： AuraSQL作业管理

相关文档