GetRayHistoryServer-阿里云帮助中心

Retrieves the details of a specific RayHistoryServer.

Operation description

Before you call this API operation, make sure that you understand the billing methods and pricing of PAI-DLC.

Important The total length of the parameters for the CreateJob API, including system-generated parameters, cannot exceed 65,536 bytes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
RayHistoryServerId	string	Yes	The ID of the Ray history server.	rhsxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
WorkspaceId	string	The ID of the workspace to which the job belongs.	46099
DisplayName	string	The display name of the job.	my-ray-history-server
UserId	string	The ID of the user who creates the job.	123456789
Username	string	The username of the user who creates the job.	myusername
TenantId	string	The tenant ID.	10**************14
RayHistoryServerId	string	The ID of the Ray history server.	rhsxxx
RayHistoryServerUrl	string	The URL of the Ray dashboard.	https://rhsxxx-dashboard.dsw-gateway-cn-wulanchabu.data.aliyun.com/
StoragePath	string	The storage path of Ray logs.	oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp
ResourceId	string	The ID of the resource group to which the job belongs.	quotaxxx
ResourceName	string	The name of the resource on which the job runs.	my-resource-name
Status	string	The status of the job.	running
ReasonCode	string	The code of the job status.	NotFound
ReasonMessage	string	The message that describes the job status.	""
GmtCreateTime	string	The time when the job was created. The time is in UTC.	2021-01-12T14:35:01Z
GmtModifyTime	string	The time when the job was last modified. The time is in UTC.	2021-01-12T14:36:00Z
GmtFinishTime	string	The time when the job is complete. The time is in UTC.	2021-01-12T15:36:08Z
MaxRuntimeMinutes	integer	The maximum running time. Unit: minutes.	1000
EcsSpec	string	The specifications of the public resource group. For a list of supported instance types, see PAI-DLC billing. Important Pricing varies based on the specifications.	ecs.g6.large
Accessibility	string	The visibility of the job.	PRIVATE

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidRayHistoryServer.NotFound	The specified RayHistoryServer does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.