Help Center/ Cloud Data Center / API Reference/ API/ Physical Server Management/ Downloading a Log File
Updated on 2025-07-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Downloading a Log File

Function

This API is used to download a server log file.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/physicalservers/{id}/logs/exports/{export_id}/content

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID.

Constraints

N/A

Range

The 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

export_id

Yes

String

Definition

Log export ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameter

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: 200

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-Type

String

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

Content-Transfer-Encoding

String

The encoding mode is fixed at binary.
Table 4 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 429

Table 6 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Constraints

N/A

Range

N/A

Default Value

N/A

error_msg

String

Definition

Error message.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Downloading logs
GET https://{endpoint}/v1/{project_id}/physicalservers/{id}/logs/exports/{export_id}/content

Example Responses

None

Status Codes

Status Code

Description

200

The byte stream of a log file has been returned.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

For details, see Error Codes.