查询 RayHistoryServer
接口说明
请确保在使用该接口前，已充分了解 PAI-DLC 产品的收费方式和价格。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/rayhistoryservers/{RayHistoryServerId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RayHistoryServerId |
string |
是 |
请求的 RayHistoryServer ID。 |
rhsxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| WorkspaceId |
string |
任务所属工作空间 ID。 |
46099 |
| DisplayName |
string |
任务的显示名称。 |
my-ray-history-server |
| UserId |
string |
按照所属用户 ID 过滤。 |
123456789 |
| Username |
string |
按所属用户名过滤。 |
myusername |
| TenantId |
string |
租户 ID。 |
10**************14 |
| 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。 |
quotaxxx |
| ResourceName |
string |
作业运行的资源名称。 |
my-resource-name |
| Status |
string |
状态。 |
running |
| ReasonCode |
string |
状态详情码。 |
NotFound |
| ReasonMessage |
string |
状态详情。 |
"" |
| GmtCreateTime |
string |
创建时间（UTC） |
2021-01-12T14:35:01Z |
| GmtModifyTime |
string |
修改时间（UTC）。 |
2021-01-12T14:36:00Z |
| GmtFinishTime |
string |
结束时间（UTC） |
2021-01-12T15:36:08Z |
| MaxRuntimeMinutes |
integer |
最大运行时长。 |
1000 |
| EcsSpec |
string |
公共资源组的硬件规格，请访问PAI-DLC 计费说明获取详细规格列表。 重要 不同规格的价格会有区别。 |
ecs.g6.large |
| Accessibility |
string |
可见性。 |
PRIVATE |
示例
正常返回示例
JSON格式
{
"WorkspaceId": "46099",
"DisplayName": "my-ray-history-server",
"UserId": "123456789",
"Username": "myusername",
"TenantId": "10**************14",
"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": "quotaxxx",
"ResourceName": "my-resource-name",
"Status": "running",
"ReasonCode": "NotFound",
"ReasonMessage": "\"\"",
"GmtCreateTime": "2021-01-12T14:35:01Z",
"GmtModifyTime": "2021-01-12T14:36:00Z",
"GmtFinishTime": "2021-01-12T15:36:08Z",
"MaxRuntimeMinutes": 1000,
"EcsSpec": "ecs.g6.large",
"Accessibility": "PRIVATE"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | InvalidRayHistoryServer.NotFound | The specified RayHistoryServer does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。