文档首页/ 智能数据湖 AI DataLake/ API参考/ Ray相关API/ RayJob管理/ 创建交互式会话 - createRaySession
更新时间:2026-10-10 GMT+08:00
分享

创建交互式会话 - createRaySession

功能介绍

创建一个交互式会话。本接口为同步接口,用于Notebook等交互式工具连接Ray集群。联邦用户认证场景下,会返回含联邦用户身份对应的凭据名称。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

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

约束限制:不涉及。

取值范围:长度为1~36的英文字符、数字和中划线的组合。

默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

约束限制:不涉及。

取值范围:长度不超过65534个字符。

默认取值:不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释:会话名称。

约束限制:不涉及。

取值范围:长度为1~47的中文、字母、数字、中划线、半角句号、空格的组合。

默认取值:不涉及。

description

否

String

参数解释:描述信息。

约束限制:不涉及。

取值范围:0~1024字符。

默认取值:不涉及。

endpoint_name

是

String

参数解释:端点名称。

约束限制:遵循RFC 1035规范,字母开头,字母或数字结尾。

取值范围:长度为1~63个字符,包含小写字母、数字、中划线的组合。

默认取值:不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

session_id

String

参数解释:会话ID。

取值范围:长度为1~36的英文、数字和中划线的组合。

secret_name

String

参数解释:pod-agency委托Secret名称,用于挂载联邦身份凭证。非AIHub联邦认证场景下返回空字符串。

取值范围:长度不超过256个字符,为空时返回空字符串。

ray_grpc_server_port

String

参数解释:Ray集群GRPC连接端口号。

取值范围:长度不超过5个字符,为空时返回空字符串。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

状态码:408

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:错误码。

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

error_msg

String

参数解释:错误描述。

取值范围:长度为2~512个字符。

solution_msg

String

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

取值范围:长度为0~4096个字符。

请求示例

创建一个交互式会话。

POST https://{endpoint}/v2/workspaces/{workspace_id}/ray-sessions

{
  "name" : "my-session",
  "description" : "交互式会话示例",
  "endpoint_name" : "ray"
}

响应示例

状态码:200

{
  "session_id" : "ac8111bf-3601-4905-8ddd-b41d3e636a4e",
  "secret_name" : "pod_agency_myAgency_001234_20260717120000",
  "ray_grpc_server_port" : "10001"
}

状态码:400

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException",
  "solution_msg" : "Check whether the request parameters comply with the API definition and try again"
}

状态码:401

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed",
  "solution_msg" : "Please check if auth token is included in the request header."
}

状态码:403

{
  "error_code" : "APIG.1003",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "solution_msg" : "Check whether the token in the request is valid and try again."
}

状态码:404

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404",
  "solution_msg" : "Please try to use correct info."
}

状态码:408

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred",
  "solution_msg" : "The backend request timed out — check service health and network connectivity, then retry."
}

状态码:500

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error",
  "solution_msg" : "Contact operations for analysis."
}

状态码

状态码

描述

200

创建交互式会话的响应体。

400

非法请求。

401

未经授权。

403

请求被拒绝访问。

404

所请求的资源不存在。

408

请求超时。

500

服务器内部错误。

相关文档