列出资源RayHistoryServer
接口说明
请确保在使用该接口前，已充分了解 PAI-DLC 产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
paidlc:ListRayHistoryServers |
list |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/rayhistoryservers HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
否 |
工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 |
268 |
| DisplayName |
string |
否 |
任务的显示名称。 |
test |
| Status |
string |
否 |
RayHistoryServer 状态：
|
running |
| PageNumber |
integer |
否 |
分页查询，指定当前需要返回的页码，从 1 开始往后编号。 |
1 |
| PageSize |
integer |
否 |
分页查询中，指定每页返回的 RayHistoryServer 数量。 |
10 |
| SortBy |
string |
否 |
按返回的以下字段排序。
|
GmtCreateTime |
| Order |
string |
否 |
排序顺序。
|
desc |
| ShowOwn |
boolean |
否 |
是否只返回当前登录者所创建的 RayHistoryServer。 |
true |
| StartTime |
string |
否 |
开始时间。 |
2020-11-08T16:00:00Z |
| EndTime |
string |
否 |
查询区间的截止时间；使用任务的创建时间来过滤。 |
2020-11-09T16:00:00Z |
| ModifiedAfter |
string |
否 |
按修改后时间过滤 |
2020-11-09T16:00:00Z |
| ResourceId |
string |
否 |
资源组 ID。如何查询专有资源组 ID，详情请参见管理资源配额。 |
quotaxxx |
| PaymentType |
string |
否 |
付费类型。
|
Postpaid |
| IdPrefix |
string |
否 |
ID 前缀 |
按ID前缀过滤 |
| UserIdForFilter |
string |
否 |
按用户 ID 过滤 |
123456789 |
| Username |
string |
否 |
按用户名称过滤 |
myusername |
| StoragePath |
string |
否 |
Ray 日志存储路径 |
oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
本次调用的请求 ID，用于诊断和答疑。 |
473469C7-AA6F-4DC5-B3DB-xxxxxxx |
| TotalCount |
integer |
符合过滤条件的总任务数。 |
1 |
| RayHistoryServers |
array<object> |
RayHistoryServer 列表 |
|
|
object |
RayHistoryServer 列表 |
||
| WorkspaceId |
string |
工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 |
153466 |
| DisplayName |
string |
任务的显示名称。 |
AEB-RECHARGE-TASK-14478-1778466397-main-4- |
| UserId |
string |
用户 ID |
123456789 |
| Username |
string |
用户名 |
myusername |
| TenantId |
string |
租户 ID。 |
1335237941080704 |
| RayHistoryServerId |
string |
创建的 Ray History Server ID。 |
rhsxxx |
| RayHistoryServerUrl |
string |
Ray Dashboard URL。 |
https://rhsxxx-dashboard.dsw-gateway-cn-wulanchabu.data.aliyun.com/ |
| StoragePath |
string |
Ray 日志存储路径 |
oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp |
| ResourceId |
string |
资源组 ID。如何查询专有资源组 ID，详情请参见管理资源配额。 |
quotazoqd53w0q75 |
| ResourceName |
string |
作业运行的资源名称。 |
OWNER_REPO |
| EcsSpec |
string |
公共资源组的硬件规格，请访问PAI-DLC 计费说明获取详细规格列表。 重要 不同规格的价格会有区别。 |
ecs.g6.xlarge |
| Accessibility |
string |
作业的可见性，取值如下：
|
PUBLIC |
| Status |
string |
Tensorboard 状态：
|
Created |
| ReasonCode |
string |
状态详情码。 |
InvalidParameter |
| ReasonMessage |
string |
状态详情。 |
PyTorchJob dlc1tx4b9lw3ntb9 is running. |
| GmtCreateTime |
string |
作业创建时间， UTC 格式。 |
2025-12-30T02:43:52Z |
| GmtModifyTime |
string |
最后修改时间（UTC）。 |
2026-05-19T04:05:46Z |
| GmtFinishTime |
string |
结束时间（UTC） |
2026-01-27T09:17:11Z |
| MaxRuntimeMinutes |
integer |
最大运行时长。 |
1000 |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxx",
"TotalCount": 1,
"RayHistoryServers": [
{
"WorkspaceId": "153466",
"DisplayName": "AEB-RECHARGE-TASK-14478-1778466397-main-4-",
"UserId": "123456789",
"Username": "myusername",
"TenantId": "1335237941080704",
"RayHistoryServerId": "rhsxxx",
"RayHistoryServerUrl": "https://rhsxxx-dashboard.dsw-gateway-cn-wulanchabu.data.aliyun.com/",
"StoragePath": "oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp",
"ResourceId": "quotazoqd53w0q75",
"ResourceName": "OWNER_REPO",
"EcsSpec": "ecs.g6.xlarge",
"Accessibility": "PUBLIC",
"Status": "Created",
"ReasonCode": "InvalidParameter",
"ReasonMessage": "PyTorchJob dlc1tx4b9lw3ntb9 is running.",
"GmtCreateTime": "2025-12-30T02:43:52Z",
"GmtModifyTime": "2026-05-19T04:05:46Z",
"GmtFinishTime": "2026-01-27T09:17:11Z",
"MaxRuntimeMinutes": 1000
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。