ListRayLogs - E-MapReduce - Alibaba Cloud Documentation Center

Lists Ray logs.

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/interactive/v1/workspace/{workspaceId}/ray/{instanceId}/logs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	No	The workspace ID.	w-d2d82aa09155
instanceId	string	No	The ID of the Ray job.	rj-311d343123

Request parameters

Parameter	Type	Required	Description	Example
bucketName	string	No	The bucket name.	mybucket
prefix	string	No	The prefix that the keys of the returned files must start with.	/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/
marker	string	No	The marker after which the returned objects are listed in alphabetical order.	test1.txt
delimiter	string	No	The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a set of elements (CommonPrefixes).	/
maxKeys	integer	No	The maximum number of objects to return. If the listing cannot be completed in a single request due to the max-keys setting, a NextMarker element is included in the response as the marker for the next listing request. Valid values: greater than 0 and less than 1000. Default value: 100.	50

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	DD6B1B2A-5837-5237-ABE4-FF0C8944
code	string	The response status code. The value 1000000 indicates success.	1000000
message	string	The error message.	ok
data	object	The returned data.
bucketName	string	The OSS bucket name.	mybucket
prefix	string	The prefix that the keys of the returned files must start with.	/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/
marker	string	The marker after which the returned objects are listed in alphabetical order.	test1.txt
maxKeys	integer	The maximum number of objects to return.	50
delimiter	string	The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a set of elements (CommonPrefixes).	/
isTruncated	boolean	Indicates whether the results returned in the request are truncated.	true
nextMarker	string	The marker from which the next listing of files starts.	test2.txt
objectList	array<object>	The list of object metadata.
	object	The object data.
name	string		test1.txt
path	string		/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/test1.txt
isDir	boolean		false
timeModified	integer		17344656363434
size	integer		535345

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "code": "1000000",
  "message": "ok",
  "data": {
    "bucketName": "mybucket",
    "prefix": "/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/",
    "marker": "test1.txt",
    "maxKeys": 50,
    "delimiter": "/",
    "isTruncated": true,
    "nextMarker": "test2.txt",
    "objectList": [
      {
        "name": "test1.txt",
        "path": "/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/test1.txt",
        "isDir": false,
        "timeModified": 17344656363434,
        "size": 535345
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.