本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ SQL业务接口/ 创建SQL的session

创建SQL的session

更新时间：2025-06-12 GMT+08:00

查看PDF

功能介绍

创建SQL Session。用户通过此接口在某SQL端点创建SQL Session，通过输入端点id、LakeFormation配置，返回Session信息。此接口为同步接口，无配套使用接口和特殊场景。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST https://localhost.com/v1/workspaces/{workspace_id}/sessions

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间的ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释：租户token。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
endpoint_id	是	EndpointId object	参数解释：endpoint空间ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。
lake_formation_config	是	LakeFormationInfo object	参数解释：LakeFormation相关信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
wait_timeout	否	Integer	参数解释：创建session排队等待时间，单位秒。约束限制：不涉及。取值范围：[300,7200]。默认取值：不涉及。

表4 EndpointId
参数	是否必选	参数类型	描述
-	否	String	参数解释：endpoint空间ID。约束限制：不涉及。取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。默认取值：不涉及。

表5 LakeFormationInfo
参数	是否必选	参数类型	描述
instance_id	是	String	参数解释：lakeformation实例ID。约束限制：不涉及。取值范围：长度为[1,64]的英文字符、数字和中划线(-)的组合。默认取值：不涉及。
catalog	是	String	参数解释：lakeformation的catalog。约束限制：不涉及。取值范围：长度为[1,255]的英文字符、数字、中划线(-)和下划线(_)的组合。默认取值：不涉及。

响应参数

状态码：200

表6 响应Body参数
参数	参数类型	描述
session_id	String	参数解释：Session的ID。约束限制：不涉及。取值范围：长度为[1,32]的英文字符、数字和中划线(-)等特殊符号的组合。默认取值：不涉及。
status	String	参数解释：session的状态。约束限制：不涉及。取值范围：[0,64]。默认取值：不涉及。

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度[8,36]。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度[2,4096]。默认取值：不涉及。

状态码：401

表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]。默认取值：不涉及。

请求示例

POST https://endpoint/v1/workspaces/{workspace_id}/sessions

{
  "endpoint_id" : "b935d0ef-f4eb-4b95-aff1-9d33ae9f57b6",
  "lake_formation_config" : {
    "instance_id" : "0b5633ba2b904511ad514346f4d23d4b",
    "catalog" : "string"
  }
}

响应示例

状态码：200

获取Session信息的响应。

{
  "session_id" : "ac8111bf-3601-4905-8ddd-b41d3e636a4e"
}

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码


状态码	描述
200	获取Session信息的响应。
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
408	Request Time-out
500	InternalServerError

错误码

请参见错误码。

父主题： SQL业务接口

上一篇：SQL业务接口

下一篇：查询Session信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问