All Products
Search
Document Center

DataWorks:GetInstanceLog

Last Updated:Sep 18, 2024

Queries the logs of an instance.

Operation description

You may not obtain the instance logs that were generated more than seven days ago.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdlongYes

The ID of the instance.

1234
ProjectEnvstringYes

The environment of the workspace. Valid values: PROD and DEV.

PROD
InstanceHistoryIdlongNo

The historical record number of the instance. You can call the ListInstanceHistory operation to query the ID.

1

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code returned.

200
Datastring

The content of the logs.

log_content
ErrorMessagestring

The error message returned.

The connection does not exist.
RequestIdstring

The ID of the request. You can locate logs and troubleshoot issues based on the ID.

E6F0DBDD-5AD****
ErrorCodestring

The error code returned.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the request is successful.

true

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": "log_content",
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history