getDbServerLogList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

View the list of Cloud DB for MongoDB database server logs.

Commands

The command statement is as follows.

ncloud vmongodb getDbServerLogList [regionCode] [logType] [cloudMongoDbServerInstanceNo] [pageNo] [pageSize] [output]

Parameter

The following describes the parameters.

Parameter	Type	Required	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained through the getRegionList action - Default: It selects the first region of the getRegionList search result	-
logType	String	Y	Database server log file type - Options: log,audit	-
cloudMongoDbServerInstanceNo	String	Y	Cloud DB for MongoDB server instance number - cloudMongoDbServerInstanceNo can be obtained through the getCloudMongoDbInstanceList action	-
pageNo	Integer	N	Page number of the paged results - The results can be paged using pageNo and pageSize	- Min: 0
pageSize	Integer	N	Size of each page to be displayed when paging - The results can be paged using pageNo and pageSize - This field must be entered when pageNo is entered	- Min: 1 - Max: 1000
output	String	N	Format type of the response result - Options: xml \| json - Default: json	-

Response

Response data type

CloudMongoDbDbServerLogList type

CloudMongoDbDbServerLogList extends CommonResponse	Description
private Integer totalRows;	Total number of lists searched
private List<CloudMongoDbDbServerLog> cloudMongoDbDbServerLogList = new ArrayList<>();	List of Cloud DB for MongoDB database server logs

CloudMongoDbDbServerLog type

CloudMongoDbDbServerLog	Description
private String fileName;	Database server log file name
private Long fileSize;	Database server log file size
private Date fileDate;	Date and time when database server log file was modified

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmongodb getDbServerLogList --regionCode KR --logType log --cloudMongoDbServerInstanceNo ****891

Response example

The following is a sample response.

When the response result format type (output) is JSON

{
  "getDbServerLogListResponse": {
    "requestId": "d733e677-ad69-4cbe-8351-711d0e0124bc",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudMongoDbDbServerLogList": {
      "cloudMongoDbDbServerLog": {
        "fileName": "mongodb.log",
        "fileSize": "194",
        "fileDate": "2021-05-27T18:10:00+0900"
      }
    }
  }
}

When the response result format type (output) is XML

<getDbServerLogListResponse>
    <requestId>d733e677-ad69-4cbe-8351-711d0e0124bc</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMongoDbDbServerLogList>
        <cloudMongoDbDbServerLog>
            <fileName>mongodb.log</fileName>
            <fileSize>194</fileSize>
            <fileDate>2021-05-27T18:10:00+0900</fileDate>
        </cloudMongoDbDbServerLog>
    </cloudMongoDbDbServerLogList>
</getDbServerLogListResponse>

Was this article helpful?

What's Next

exportDbServerLogToObjectStorage

Table of contents

Commands
Response
Examples