getDbServerLogList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Get the list of Cloud DB for MongoDB instance DB server logs.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/getDbServerLogList

Request headers

For headers common to all Cloud DB for MongoDB (VPC) APIs, see Cloud DB for MongoDB (VPC) request headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for MongoDB instance to view Check through getRegionList First Region of the `getRegionList` query result (default)
`logType`	String	Required	DB server log file type `log` \| `audit`
`cloudMongoDbServerInstanceNo`	String	Required	Cloud DB for MongoDB server instance number Check through getCloudMongoDbInstanceList
`pageNo`	Integer	Optional	Page numbers in paged results Page the result values using `pageNo` and `pageSize` 0 (minimum)
`pageSize`	Integer	Conditional	Number of results to display on a page Page the result values using `pageNo` and `pageSize` Required when entering `pageNo` 1 - 1000
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getDbServerLogList
?regionCode=KR
&logType=log
&cloudMongoDbServerInstanceNo=2515****
&pageNo=0
&pageSize=1
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See CloudMongoDbServerLogList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

If responseFormetType=json

{
    "getDbServerLogListResponse": {
        "totalRows": 3,
        "cloudMongoDbDbServerLogList": [
           {
                "fileName": "configlog.log.2024-07-01T20-00-01",
                "fileSize": 11703142,
                "fileDate": "2024-07-02T05:00:01+0900"
           }
        ],
        "requestId": "217d7b53-****-****-****-430c5a41b11f",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormetType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<getDbServerLogListResponse>
    <requestId>217d7b53-****-****-****-430c5a41b11f</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <cloudMongoDbDbServerLogList>
        <cloudMongoDbDbServerLog>
            <fileName>configlog.log.2024-07-01T20-00-01</fileName>
            <fileSize>11703142</fileSize>
            <fileDate>2024-07-02T05:00:01+0900</fileDate>
        </cloudMongoDbDbServerLog>
    </cloudMongoDbDbServerLogList>
</getDbServerLogListResponse>

Was this article helpful?

What's Next

addCloudMongoDbUserList

Table of contents

Request
Response