exportDbServerLogToObjectStorage

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスの DB Serverログファイルを Object Storageに転送します。

参考

DB Serverログファイルを Object Storageに転送するには、DB Serverログファイルの保存・検索用の Object Storageバケットが作成されている必要があります。詳細は、Object Storageガイドをご参照ください。

リクエスト

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

メソッド URI
GET, POST /exportDbServerLogToObjectStorage

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional DB Serverログファイルを Object Storageに転送する Cloud DB for MongoDBインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
logType String Required DB Serverログファイルタイプ
  • log | audit
fileName String Required DB Serverログファイル名
bucketName String Required DB Serverログファイルが転送される Object Storageバケット名
cloudMongoDbServerInstanceNo String Required Cloud DB for MongoDBサーバインスタンス番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/exportDbServerLogToObjectStorage
?regionCode=KR
&logType=log
&fileName=configlog.log.2024-07-01T**-**-**
&bucketName=bucket
&cloudMongoDbServerInstanceNo=2515****
&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}'

レスポンス

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

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

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

レスポンス例

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

  • responseFormetType=jsonの場合

    {
    "exportDbServerLogToObjectStorageResponse": {
        "requestId": "ecc1ce95-****-****-****-788c5c4fe011",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

    <?xml version="1.0" encoding="UTF-8"?>
<exportDbServerLogToObjectStorageResponse>
    <requestId>ecc1ce95-****-****-****-788c5c4fe011</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportDbServerLogToObjectStorageResponse>