DocsICP FilingConsole
Documentation

CreateRayHistoryServer

Updated at:
Copy as MD
Product
My Favorites

Creates a RayHistoryServer.

Operation description

Before you use this operation, make sure that you are familiar with the billing of PAI-DLC and the pricing.

Important The total length of CreateJob request parameters, 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

POST /api/v1/rayhistoryservers HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body parameters.

DisplayName

string

Yes

The display name of the job.

my-ray-history-server
StoragePath

string

Yes

The storage path for Ray logs.

oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp
WorkspaceId

string

No

The workspace ID. For information about how to obtain the workspace ID, see ListWorkspaces..

12345
ResourceId

string

No

The resource group ID. This parameter is optional.

  • If this parameter is left empty, the job is committed to the public resource group.

  • If the current workspace is attached to a resource quota, you can specify the corresponding resource quota ID. For details about how to query the resource quota ID, see Manage resource quotas.

quotaxxx
EcsSpec

string

No

The hardware specifications of the public resource group. To access the detailed list of specifications, see PAI-DLC billing.

Important Prices vary depending on the specifications.
.

ecs.c6.large
MaxRuntimeMinutes

integer

No

The maximum runtime in minutes.

1000
Accessibility

string

No

The visibility of the job. Valid values:

  • PUBLIC: visible to all members in the workspace.

  • PRIVATE: visible only to you and administrators in the workspace.

PRIVATE

Response elements

Element

Type

Description

Example

object

The root node.

RequestId

string

The request ID of this call, used for diagnostics and troubleshooting.

473469C7-AA6F-4DC5-B3DB-xxxxxxx
RayHistoryServerId

string

The ID of the created Ray History Server.

rhsxxxx

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-xxxxxxx",
  "RayHistoryServerId": "rhsxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.