创建SQL的session
功能介绍
创建SQL Session。用户通过此接口在某SQL端点创建SQL Session,通过输入端点id、LakeFormation配置,返回Session信息。此接口为同步接口,无配套使用接口和特殊场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST https://localhost.com/v1/workspaces/{workspace_id}/sessions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace_id |
是 |
String |
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
endpoint_id |
是 |
EndpointId object |
|
lake_formation_config |
是 |
LakeFormationInfo object |
|
wait_timeout |
否 |
Integer |
|
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
session_id |
String |
|
status |
String |
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:408
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
|
error_msg |
String |
|
solution_msg |
String |
|
请求示例
创建SQL Session。用户通过此接口在某SQL端点创建SQL Session,通过输入端点id、LakeFormation配置,返回Session信息。此接口为同步接口,无配套使用接口和特殊场景。
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 |
错误码
请参见错误码。