Help Center/Cloud Data Center/API Reference/API/Physical Server Management/Exporting Server Logs
Updated on 2025-12-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Exporting Server Logs

Function

This API is used to create an asynchronous task for exporting server logs. The system queries the log export status using ShowLogsExportStatus. When the status is completed, DownloadServerLogs is called to download log files.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/physicalservers/{id}/logs/exports

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID.

Constraints

N/A

Range

Project ID of the account.

Default Value

N/A

id

Yes

String

Definition

Server ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 3 Response header parameters

Parameter

Type

Description

Content-Disposition

String

The format is attachment; filename=${id}-dump.tar.gz. id indicates the unique server SN.

Content-Transfer-Encoding

String

The encoding mode is fixed at binary.

Content-Type

String

The content type is fixed at application/octet-stream;charset=UTF-8.

Table 4 Response body parameters

Parameter

Type

Description

export_id

String

export task id

status

String

Definition

Export progress.

Constraints

N/A

Range

  • processing: The export is in progress.

  • completed: The export is complete.

Default Value

N/A

percentage

String

Definition

Export progress percentage.

Constraints

N/A

Range

0-100

Default Value

N/A

created_at

String

Definition

Export start time.

Constraints

N/A

Range

The timestamp format is ISO 8601, for example, 2025-03-20T02:48:06+00:00.

Default Value

N/A

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 429

Table 6 Response body parameters

Parameter

Type

Description

-

String

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Example Requests

Exporting server logs

POST https://{endpoint}/v1/{project_id}/physicalservers/{id}/logs/exports

{ }

Example Responses

Status code: 202

Log package flow file is returned.

{
  "export_id" : "1",
  "status" : "Running",
  "percentage" : "30%",
  "created_at" : "2024-07-01T11:32:49Z"
}

Status Codes

Status Code

Description

202

Log package flow file is returned.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

See Error Codes.