exportDbServerLogToObjectStorage

Prev Next

Classic環境で利用できます。

概要

Cloud DBのデータベースサーバログファイルを Object Storageに送信します。

リクエスト

リクエストヘッダ

ヘッダ名 説明
x-ncp-apigw-timestamp 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGWから発行されたキー値、v2を使用する場合、api-keyは使用しない
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key NAVERクラウドプラットフォームポータルで発行された Access Key ID値
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Access Key ID値と Secret Keyで暗号化した署名
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Request body content typeを application/jsonに指定
Content-Type: application/json

リクエストボディ

APIリクエスト時にフィールド名の大文字・小文字の区別が必要です。

パラメータ名 要否 タイプ 制約事項 説明
regionNo N String リージョン番号
dbKindCode Y String MYSQL DBタイプコード
fileName Y String - データベースサーバログのファイル名
- getDbServerLogListを通じて取得可能
bucketName Y String - Object Storageのバケット名
-bucketNameは、ListBucketsアクションを通じて取得可能
cloudDBInstanceNo Y String - 作成されている MySQLサーバのインスタンス番号
- getCloudDBInstanceListを通じて取得する値
cloudDBServerInstanceNo Y String - Cloud DB for MySQLのサーバインスタンス番号
- getCloudDBInstanceListを通じて取得可能
logType Y String BINARY, ERROR, SLOW, GENERAL データベースサーバログのファイルタイプ
responseFormatType N String xml, json レスポンス結果のフォーマットタイプ
Default : xml
  • regionNo
    • Server APIである getRegionListを通じて取得できます。
  • dbKindCode
    • 照会する CloudDBの種類を選択します。MySQLのみ入力可能です。
  • fileName
  • bucketName
    • コンソールに作成されたバケット名を入力します。
  • cloudDBInstanceNo
    • 作成されている MySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
  • cloudDBServerInstanceNo
    • 作成されている MySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
  • LogType
    • データベースのサーバログファイルタイプを設定します。 BINARY、ERROR、SLOW、GENERALから選択できます。
  • responseFormatType
    • API実行結果のレスポンスを受けるフォーマットを設定します。 xmlと jsonの中から選択できます。

レスポンス

フィールド名 タイプ 説明 備考
requestId String リクエスト ID値
returnCode Integer レスポンスコード値
returnMessage String レスポンスメッセージ

例

リクエスト例

GET {API_URL}/exportDbServerLogToObjectStorage
?regionNo=1
&dbKindCode=MYSQL
&fileName=20221209
&bucketName=temp-bucket
&cloudDBInstanceNo=15064241
&cloudDBServerInstanceNo=15064245
&logType=BINARY
&responseFormatType=XML

リクエストサンプル

{
  "regionNo": "1",
  "dbKindCode": "MYSQL",
  "fileName": "20221209",
  "bucketName": "temp-bucket",
  "cloudDBInstanceNo": "15064241",
  "cloudDBServerInstanceNo": "15064245",
  "logType": "BINARY",
  "responseFormatType": "xml"
}

レスポンス例

 connection: keep-alive 
 content-type: application/xml;charset=UTF-8 
 date: Fri, 09 Dec 2022 06:51:39 GMT 
 server: nginx 
 transfer-encoding: chunked 
 x-ncp-apigw-response-origin: ENDPOINT 
 x-ncp-trace-id: 3ce9h6sqm2cpi6cdj460s6copg 

<exportDbServerLogToObjectStorageResponse>
  <requestId>e2cbeac2-1583-479a-a8a3-ed72b3c899a0</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
</exportDbServerLogToObjectStorageResponse>

エラーコード

Cloud DB APIリクエストに誤りがあるか、処理中にエラーが発生した場合、HTTPステータスコードで成功/失敗を、JSON形式で詳細メッセージを返します。

エラーコードには、Cloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の2種類があります。

エラーコード レスポンスメッセージ 説明
200 Ok
500 Server Error