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}
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
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
Parameter | Type | Description |
|---|---|---|
export_id | String | export task id |
status | String | Definition Export progress. Constraints N/A Range
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
Parameter | Type | Description |
|---|---|---|
error_code | String | Definition Error code. |
error_msg | String | Definition Error description. |
Status code: 429
Parameter | Type | Description |
|---|---|---|
- | String |
Status code: 500
Parameter | Type | Description |
|---|---|---|
error_code | String | Definition Error code. |
error_msg | String | Definition Error description. |
Example Requests
Querying the log export status
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
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
