getCloudMysqlEventHistoryList

Prev Next

VPC環境で利用できます。

Cloud DB for MySQLインスタンスのイベント履歴リストを照会します。

コマンド

コマンド構文は次の通りです。

ncloud vmysql getCloudMysqlEventHistoryList [regionCode] [cloudMysqlServerName] [startDate] [endDate] [pageNo] [pageSize] [output]

パラメータ

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

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N Cloud DB for MySQLインスタンスが存在するリージョンコード
  • getRegionListアクションを通じて取得可能
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
-
cloudMysqlServerName String Y Cloud DB for MySQLサーバ名 -
startDate String Y 照会開始日
  • 照会開始日の日付形式: yyyy-MM-dd HH:mm:ss
  • <例> 2024-01-01 00:00:00
-
endDate String Y 照会終了日
  • 照会終了日の日付形式: yyyy-MM-dd HH:mm:ss
  • <例> 2024-12-31 23:59:59
-
pageNo Integer N ページングされた結果のページ番号
  • pageNopageSizeを利用してページング処理
  • 0 (デフォルト)
最小: 0
pageSize Integer N ページごとに表示する結果数
  • pageNopageSizeを利用してページング処理
  • 20 (デフォルト)
最小: 1
output String N レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: json
-

レスポンス

レスポンスデータタイプ

コマンドの呼び出しに対するレスポンスデータタイプは次の通りです。

  • CloudMysqlEventHistoryListタイプ
CloudMysqlEventHistoryList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudMysqlEventHistory> cloudMysqlEventHistoryList = new ArrayList<>();
  • CloudMysqlEventHistoryタイプ
CloudMysqlEventHistory 説明
private String cloudMysqlInstanceNo; Cloud DB for MySQLのインスタンス番号
private String cloudMysqlServerInstanceNo; Cloud DB for MySQLサーバインスタンス番号
private String cloudMysqlServerName; Cloud DB for MySQLサーバ名
private String eventTime; イベントの発生時間
private String eventType; イベントタイプ
private String eventName; イベント名
private String eventContent; イベントの内容
private String clientIp; アクセス IPアドレス

呼び出しとレスポンスの例を説明します。

呼び出し例

呼び出しのサンプルコードは次の通りです。

ncloud vmysql getCloudMysqlEventHistoryList --regionCode KR --cloudMysqlServerName abcd --startDate '2024-08-13 17:00:00' --endDate '2024-08-13 17:00:00' --pageNo 0 --pageSize 10

レスポンス例

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

レスポンス結果の形式タイプ(output)が jsonの場合

{
  "getCloudMysqlEventHistoryListResponse": {
    "totalRows": 2,
    "cloudMysqlEventHistoryList": [
      {
        "cloudMysqlInstanceNo": "****890",
        "cloudMysqlServerInstanceNo": "****891",
        "cloudMysqlServerName": "abcd-001-****",
        "eventTime": "2024-08-13 17:10:00",
        "eventType": "DB Server",
        "eventName": "DB",
        "eventContent": "DB start",
        "clientIp": "10.x.x.x"
      },
      {
        "cloudMysqlInstanceNo": "****890",
        "cloudMysqlServerInstanceNo": "****891",
        "cloudMysqlServerName": "abcd-001-****",
        "eventTime": "2024-08-13 17:20:00",
        "eventType": "DB Server",
        "eventName": "DB",
        "eventContent": "Change Spec MySQL Completed",
        "clientIp": "10.x.x.x"
      }
    ],
    "requestId": "36cc2f85-****-****-****-5d2511df4e45",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

レスポンス結果の形式タイプ(output)が xmlの場合

<?xml version="1.0" encoding="UTF-8"?>
<cloudMysqlEventHistoryList>
    <requestId>36cc2f85-****-****-****-5d2511df4e45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMysqlEventHistoryList>
        <CloudMysqlEventHistory>
            <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
            <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
            <cloudMysqlServerName>abcd-001-****</cloudMysqlServerName>
            <eventTime>2024-08-13 17:10:00</eventTime>
            <eventType>DB Server</eventType>
            <eventName>DB</eventName>
            <eventContent>DB start</eventContent>
            <clientIp>10.x.x.x</clientIp>
        </CloudMysqlEventHistory>
        <CloudMysqlEventHistory>
            <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
            <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
            <cloudMysqlServerName>abcd-001-****</cloudMysqlServerName>
            <eventTime>2024-08-13 17:10:00</eventTime>
            <eventType>DB Server</eventType>
            <eventName>DB</eventName>
            <eventContent>Change Spec MySQL Completed</eventContent>
            <clientIp>10.x.x.x</clientIp>
        </CloudMysqlEventHistory>
    </cloudMysqlEventHistoryList>
</cloudMysqlEventHistoryList>