Updated on 2025-12-19 GMT+08:00

Downloading a Log File

Function

This API is used to download server log files.

Calling Method

For details, see Calling APIs.

URI

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

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

export_id

Yes

String

Definition

Log export ID, which is contained in the response body after the log export request is successfully sent.

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

Parameter

Type

Description

-

String

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

Downloading a log file

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 logs has been returned.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

See Error Codes.