Help Center/ Cloud Data Center / API Reference/ API/ Physical Server Management/ Querying the Export Status of Logs
Updated on 2025-07-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Export Status of Logs

Function

This API is used to query the log collection status and progress.

Calling Method

For details, see Calling APIs.

URI

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

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 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 4 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 5 Response body parameter

Parameter

Type

Description

-

String

-

Status code: 500

Table 6 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 querying the export status of logs

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

Example Responses

Status code: 200

Logs are exported.

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

Status Codes

Status Code

Description

200

Logs are exported.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

For details, see Error Codes.