getDbServerLogList

Prev Next

Classic環境で利用できます。

概要

Cloud DBデータベースサーバのログリストを照会します。

リクエスト

リクエストヘッダ

ヘッダ名 説明
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タイプコード
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のみ選択できます。
  • cloudDBInstanceNo
    • 作成されている MySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
  • cloudDBServerInstanceNo
    • Cloud DB for MySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
  • LogType
    • データベースサーバログのファイルタイプを決めます。BINARY、ERROR、SLOW、GENERALの中から選択可能です。
  • responseFormatType
    • API実行結果のレスポンスを受けるフォーマットを決めます。xmlと jsonの中から選択可能です。

レスポンス

フィールド名 タイプ 説明 備考
requestId String リクエスト ID値
returnCode Integer レスポンスコード値
returnMessage String レスポンスメッセージ
totalRows Integer レスポンス結果の row数
cloudDBServerLogList[] String DBサーバログリスト CloudDBServerLogList
  • CloudDBServerLog
フィールド名 タイプ 説明 備考
fileName String ファイル名
fileDate Date ファイル日付
fileSize Long ファイルサイズ

例

リクエスト例

GET {API_URL}/getDbServerLogList
?regionNo=1
&dbKindCode=MYSQL
&cloudDBInstanceNo=15101399
&cloudDBServerInstanceNo=15101410
&logType=BINARY
&responseFormatType=XML

リクエストサンプル

{
  "regionNo": "1",
  "dbKindCode": "MYSQL",
  "cloudDBInstanceNo": "15101399",
  "cloudDBServerInstanceNo": "15101410",
  "logType": "BINARY",
  "responseFormatType": "XML"
}

レスポンス例

 connection: keep-alive 
 content-type: application/xml;charset=UTF-8 
 date: Mon, 12 Dec 2022 06:32:04 GMT 
 server: nginx 
 transfer-encoding: chunked 
 x-ncp-apigw-response-origin: ENDPOINT 
 x-ncp-trace-id: 6cp3664oj8cpl62phhclhjgdr4 

<getDbServerLogListResponse>
  <requestId>e604306e-7e5a-47ba-9e9f-be6f67e5946c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>  
  <totalRows>1</totalRows>
  <cloudDbServerLogList>
    <cloudDbServerLog>
     <fileName>mysql-bin.000001</fileName>
     <fileSize>8038</fileSize>
     <fileDate>2022-12-12T14:38:23+0900</fileDate>
    </cloudDbServerLog>
  </cloudDbServerLogList> 
</getDbServerLogListResponse>

エラーコード

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

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

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