GetRayHistoryServer - 获取 RayHistoryServer-人工智能平台 PAI(PAI)-阿里云帮助中心

查询 RayHistoryServer

接口说明

请确保在使用该接口前，已充分了解 PAI-DLC 产品的收费方式和价格。

重要 CreateJob 接口参数总长度（包含系统生成的参数）不能超过 65536 个字节，

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidlc:GetRayHistoryServer

get

*全部资源

*

无

请求语法

GET /api/v1/rayhistoryservers/{RayHistoryServerId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
RayHistoryServerId	string	是	请求的 RayHistoryServer ID。	rhsxxx

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
Accessibility	string	可见性。	PRIVATE
DisplayName	string	任务的显示名称。	my-ray-history-server
EcsSpec	string	公共资源组的硬件规格，请访问PAI-DLC 计费说明获取详细规格列表。重要不同规格的价格会有区别。	ecs.g6.large
GmtCreateTime	string	创建时间（UTC）	2021-01-12T14:35:01Z
GmtFinishTime	string	结束时间（UTC）	2021-01-12T15:36:08Z
GmtModifyTime	string	修改时间（UTC）。	2021-01-12T14:36:00Z
MaxRuntimeMinutes	integer	最大运行时长。	1000
RayHistoryServerId	string	请求的 Ray History Server ID。	rhsxxx
RayHistoryServerUrl	string	Ray Dashboard URL。	https://rhsxxx-dashboard.dsw-gateway-cn-wulanchabu.data.aliyun.com/
ReasonCode	string	状态详情码。	NotFound
ReasonMessage	string	状态详情。	""
ResourceId	string	任务运行所在的资源组 ID。	quotaxxx
ResourceName	string	作业运行的资源名称。	my-resource-name
Status	string	状态。	running
StoragePath	string	Ray 日志存储路径	oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp
TenantId	string	租户 ID。	10**************14
UserId	string	按照所属用户 ID 过滤。	123456789
Username	string	按所属用户名过滤。	myusername
WorkspaceId	string	任务所属工作空间 ID。	46099

示例

正常返回示例

JSON格式

{
  "Accessibility": "PRIVATE",
  "DisplayName": "my-ray-history-server",
  "EcsSpec": "ecs.g6.large",
  "GmtCreateTime": "2021-01-12T14:35:01Z",
  "GmtFinishTime": "2021-01-12T15:36:08Z",
  "GmtModifyTime": "2021-01-12T14:36:00Z",
  "MaxRuntimeMinutes": 1000,
  "RayHistoryServerId": "rhsxxx",
  "RayHistoryServerUrl": "https://rhsxxx-dashboard.dsw-gateway-cn-wulanchabu.data.aliyun.com/",
  "ReasonCode": "NotFound",
  "ReasonMessage": "\"\"",
  "ResourceId": "quotaxxx",
  "ResourceName": "my-resource-name",
  "Status": "running",
  "StoragePath": "oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp",
  "TenantId": "10**************14",
  "UserId": "123456789",
  "Username": "myusername",
  "WorkspaceId": "46099"
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidRayHistoryServer.NotFound	The specified RayHistoryServer does not exist.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。