Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

exportDbServerLogToObjectStorage

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET | POST /vmysql/v2/exportDbServerLogToObjectStorage

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • DB Serverログファイルを Object Storageに転送する Cloud DB for MySQLインスタンスのリージョンコード
  • getRegionListを参照
  • デフォルト: getRegionList照会結果の最初のリージョン
logType String Required DB Serverログファイルタイプ
  • BINARY | ERROR | SLOW | GENERAL | AUDIT
    • BINARY: マスターサーバで発生したすべてのデータ変更を記録
    • ERROR: DB Serverで発生したエラーを記録
    • SLOW: 設定された時間以上実行されたクエリと関連情報を記録
    • GENERAL: 実行されたすべての SQLクエリと関連情報を記録
    • AUDIT: セキュリティ関連イベントを記録
fileName String Required DB Serverログファイル名
bucketName String Required DB Serverログファイルが転送される Object Storageバケット名
folderPath String Optional DB Serverログファイルが転送されるフォルダパス
cloudMysqlServerInstanceNo String Required Cloud DB for MySQLサーバインスタンス番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/exportDbServerLogToObjectStorage
?regionCode=KR
&logType=BINARY
&fileName=mysql-bin.000001
&bucketName=mysql-bin-log
&folderPath=cloud-db-for-mysql/
&cloudMysqlServerInstanceNo=****891' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

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

Cloud DB for MySQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for MySQL (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "exportDbServerLogToObjectStorageResponse": {
        "requestId": "1cf902bb-****-****-****-28fc2494f20",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<exportDbServerLogToObjectStorageResponse>
    <requestId>1cf902bb-****-****-****-28fc2494f20c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</exportDbServerLogToObjectStorageResponse>