Query System Log List

Request URL

GET {base_url}/{api_path}/system_log/list?access_token={access_token}

Request parameters


Parameter	Required	Type	Description
page	No	Integer	Define which page is displayed.
page_size	No	Integer	Define how many records per page.
sort_by	No	String	Define the sorting field. Valid value: `file_name`
order_by	No	String	Define the display order. Valid value: `asc`: Ascending order. `desc`: Descending order.

Response parameters

Table 1.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
total_number	Integer	The total number of the system log files.
data	Array<Log_Info>	The information of the system log files.

Log_Info

Table 2.
Parameter	Type	Description
file_name	String	The date-based file name of the system log.

Examples

Request example

GET /openapi/v1.0/system_log/list?page=1&page_size=2&sort_by=file_name&order_by=desc&access_token=MCowjJR0hBY3hkptJIflnZpsbfIxQ9oE HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 4,
    "data": [
        {
            "file_name": "20240610"
        },
        {
            "file_name": "20240611"
        }
    ]
}