All Products
Search
Document Center

DataWorks:GetInstanceLog

Last Updated:Nov 21, 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

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:
    • The required resource types are displayed in bold characters.
    • 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
dataworks:*get
*All Resources
*
    none
none

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