All Products
Search
Document Center

Microservices Engine:GetLog

Last Updated:Feb 07, 2025

Queries the operational logs of a job. You can call this operation only in the professional edition.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadSchedulerxLogQueryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
NamespacestringYes

The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestringNo

The source of the namespace. This parameter is required only for a special third party.

schedulerx
GroupIdstringYes

The application group ID. You can obtain the application group ID on the Application Management page in the SchedulerX console.

testSchedulerx.defaultGroup
JobIdstringNo

The job ID.

123
JobInstanceIdstringNo

The job instance ID.

123456
StartTimestamplongNo

The time when the job starts to run. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1675739364000
EndTimestamplongNo

The time when the job stops running. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1675739484000
KeywordstringNo

The keyword.

ERROR
LineintegerNo

The number of rows to return. The maximum number is 200.

50
OffsetintegerNo

The number of offset rows. This parameter can be used for a paged query.

0
ReversebooleanNo

Specifies whether to reverse the order. By default, the order is reversed.

true

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

The HTTP status code.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The returned error message.

jobid=xxx is not existed
Dataobject

The returned data.

Logsarray

The logs. The value is an array of strings.

Logsstring

The log in each row.

hello world

Examples

Sample success responses

JSONformat

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "jobid=xxx is not existed",
  "Data": {
    "Logs": [
      "hello world"
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-18The response structure of the API has changedView Change Details