getDbServerLogList

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスの DB Serverログリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /getDbServerLogList

リクエストヘッダ

Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MongoDB (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
logType String Required DB Serverログファイルタイプ
  • log | audit
cloudMongoDbServerInstanceNo String Required Cloud DB for MongoDBサーバインスタンス番号
pageNo Integer Optional ページングされた結果のページ番号
  • pageNo、pageSizeを利用してページング処理
  • 0 (最小)
pageSize Integer Conditional ページごとに表示する結果数
  • pageNo、pageSizeを利用してページング処理
  • pageNo入力時、必須
  • 1~1000
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudMongoDbServerLogListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • 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"
    }
}

  • responseFormetType=xml(デフォルト)の場合

    <?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>