Retrieve the Ray Dashboard URL
Operation description
Before you use this operation, review the PAI-DLC billing model and pricing.
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/jobs/{jobId}/rayDashboard HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| jobId |
string |
No |
Job ID |
dlc1k7426goc7bvy |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| isShared |
boolean |
No |
Set to true to generate a shareable link. If you set this parameter to true, you must also specify the token parameter. |
false |
| token |
string |
No |
The token returned by GetToken |
some_token_value |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| url |
string |
The Ray Dashboard URL |
https://pre-pai-dlc-proxy-cn-hangzhou.aliyun.com/ray/dashboard/dlc1k7426goc7bvy |
| metricsEnabled |
string |
Indicates whether Cloud Monitor is enabled for this dashboard to display Ray metrics |
true |
Examples
Success response
JSON format
{
"url": "https://pre-pai-dlc-proxy-cn-hangzhou.aliyun.com/ray/dashboard/dlc1k7426goc7bvy",
"metricsEnabled": "true"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.