创建Session - CreateAuraV2SqlSession

功能介绍

创建SQL Session。

用户通过此接口在指定端点创建SQL Session，通过输入端点id、LakeFormation配置，返回Session信息。

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

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间的ID。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。

请求参数

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

表3 请求Body参数
参数	是否必选	参数类型	描述
endpoint_name	是	String	参数解释：Endpoint名称。约束限制：不涉及。取值范围：长度为1~128个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
catalog_context	是	CatalogContext object	参数解释：LakeFormation相关信息。约束限制：不涉及。
wait_timeout	否	Integer	参数解释：创建session排队等待时间，单位：秒。约束限制：不涉及。取值范围：300~7200。默认取值：不涉及。

表4 CatalogContext
参数	是否必选	参数类型	描述
catalog_name	是	String	参数解释：LakeFormation的catalogName。约束限制：不涉及。取值范围：长度为1~255个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
session_id	String	参数解释：Session的ID。取值范围：长度为1~32个字符，支持大小写英文字母、数字、连字符。
status	String	参数解释：session的状态。取值范围： RUNNING：运行中。 CLOSED：已关闭。 WAITING：等待中。 CREATING：创建中。 FAIL：失败。

状态码：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个字符。

请求示例

创建SQL Session。用户通过此接口在某SQL端点创建SQL Session，通过输入端点id、LakeFormation配置，返回Session信息。

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

{
  "endpoint_name" : "aura_endpoint",
  "lake_formation_config" : {
    "catalog" : "string"
  }
}

响应示例

状态码：200

请求成功。

{
  "session_id" : "ac8111bf-3601-4905-8ddd-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"
}

状态码：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 not exists.",
  "solution_msg" : "Please try to use correct info."
}

状态码：408

请求超时。

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

状态码：500

服务器内部错误。

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

状态码

状态码	描述
200	请求成功。
400	非法请求。
401	未经授权。
403	请求被拒绝访问。
404	所请求的资源不存在。
408	请求超时。
500	服务器内部错误。