Help Center/TaurusDB/API Reference/APIs (Recommended)/Log Management/Downloading an Error Log
Updated on 2026-03-16 GMT+08:00
View PDF

Downloading an Error Log

Function

This API is used to download an error log. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/{node_id}/errorlog-download

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

node_id

Yes

String

Definition

Node ID.

Constraints

N/A

Range

The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Definition

Quantity.

Range

N/A

list

Array of RDSErrorLogDownload objects

Definition

Links for downloading error logs.

Table 4 RDSErrorLogDownload

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

file_name

String

Definition

File name.

Range

N/A

status

String

Definition

Status.

Range

N/A

file_size

String

Definition

File size.

Range

N/A

file_link

String

Definition

Link for downloading the file.

Range

N/A

create_at

Integer

Definition

Creation time.

Range

N/A

updated_at

Integer

Definition

Update time.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Downloading error logs

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/d53fb62bd61e4e9e9636fd2225f395beno07/errorlog-download

Example Response

Status code: 200

Success

{
  "count" : 1,
  "list" : {
    "job_id" : "62c263e1-b8dc-4f3c-a76c-3175d13d5003",
    "file_name" : "bf8980ee81094baeb4a22193e6a23bcb_taurusdb_errorlog_download_20250902113819162",
    "status" : "SUCCESS",
    "file_size" : "3",
    "file_link" : "https://xxxxxx:xxx/bf8980ee81094baeb4a22193e6a23bcb_taurusdb_errorlog_download_20250902113819162?AWSAccessKeyId=EOCHIO6KJTEGELBPOMOJ&Expires=1756813414&response-cache-control=no-cache%2Cno-store&Signature=YOLQZ4lesVp5Ak71YPYcsD87yW0%3D",
    "create_at" : "1756813099162,",
    "updated_at" : 1756813109903
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic:Log Management