exportDbServerLogsToObjectStorage

Prev Next

VPC環境で利用できます。

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

参考

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

リクエスト

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

メソッド URI
GET | POST /vmssql/v2/exportDbServerLogsToObjectStorage
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional DB Serverログファイルを Object Storageに転送する Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを参照
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMssqlInstanceNo String Required Cloud DB for MSSQLインスタンス番号
cloudMssqlServerInstanceNo String Required Cloud DB for MSSQLサーバインスタンス番号
bucketName String Required DB Serverログファイルが転送される Object Storageバケット名
folderPath String Optional Object Storageバケットのフォルダパス
cloudMssqlObjectNameList.N List[String] Required Object Storageに転送するログファイル名リスト
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/exportDbServerLogsToObjectStorage
?regionCode=KR
&cloudMssqlInstanceNo=2517****
&cloudMssqlServerInstanceNo=2517****
&bucketName=bucket
&cloudMssqlObjectNameList.1=SQLAGENT.OUT
&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}'

レスポンス

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合

    {
        "exportDbServerLogsToObjectStorageResponse": {
            "requestId": "9d128334-****-****-****-1b9b703b1675",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormatType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <exportDbServerLogsToObjectStorageResponse>
        <requestId>9d128334-****-****-****-1b9b703b1675</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
    </exportDbServerLogsToObjectStorageResponse>