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

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: 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	Integer	Definition Export progress percentage. Constraints N/A Range 0-100 Default Value N/A
created_at	DateTime	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. 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

Request for exporting server logs

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

{ }

Example Responses

Status code: 202

Logs are compressed and returned as a stream.

{
  "export_id" : "1",
  "status" : "Running",
  "percentage" : "30%",
  "created_at" : "2024-07-01T11:32:49Z",
  "Content-Type" : "application/json; charset=utf-8"
}