getCloudMysqlInstanceList

Prev Next

VPC環境で利用できます。

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

コマンド

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

ncloud vmysql getCloudMysqlInstanceList [regionCode KR] [vpcNo] [subnetNo] [cloudMysqlServiceName] [cloudMysqlInstanceNoList] [cloudMysqlServerName] [cloudMysqlServerInstanceNoList] [generationCode] [pageNo] [pageSize] [output]

パラメータ

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

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N Cloud DB for MySQLインスタンスが存在するリージョンコード
- getRegionListアクションを通じて取得可能
- デフォルト: getRegionList照会結果の最初のリージョンを選択		 -
zoneCode String N ZONEコード
- getZoneListアクションを通じて取得可能		 -
vpcNo String N VPC番号
- getCloudMysqlTargetVpcListアクションを通じて取得可能		 -
subnetNo String N Subnet番号
- getCloudMysqlTargetSubnetListアクションを通じて取得可能		 -
cloudMysqlServiceName String N Cloud DB for MySQLサービス名
- getCloudMysqlInstanceListアクションを通じて取得可能		 -
cloudMysqlInstanceNoList List<String> N Cloud DB for MySQLインスタンス番号リスト
- getCloudMysqlInstanceListアクションを通じて取得可能
<例>
- cloudMysqlInstanceNoList 1234 2345		 -
cloudMysqlServerName String N Cloud DB for MySQLサーバ名
- getCloudMysqlInstanceListアクションを通じて取得可能		 -
cloudMysqlServerInstanceNoList List<String> N Cloud DB for MySQLサーバインスタンス番号リスト
- getCloudMysqlInstanceListアクションを通じて取得可能
<例>
-cloudMysqlServerInstanceNoList 1234 2345		 -
generationCode String N サーバの世代コード
- オプション: G2 | G3		 -
pageNo Integer N ページングされた結果のページ番号
- 結果値を pageNo、pageSizeを利用してページング処理できる		 最小: 0
pageSize Integer N ページング時に表示する各ページサイズ
- 結果値を pageNo、pageSizeを利用してページング処理できる
- pageNoを入力する際に必ず入力		 最小: 1
output String N レスポンス結果のフォーマットタイプ
- オプション: xml | json
- デフォルト: json		 -

レスポンス

レスポンスデータのタイプ

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

  • CloudMysqlInstanceListタイプ
CloudMysqlInstanceList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>();
  • CloudMysqlInstanceタイプ
CloudMysqlInstance 説明
private String cloudMysqlInstanceNo; Cloud DB for MySQLのインスタンス番号
private String cloudMysqlServiceName; Cloud DB for MySQLサービス名
private String cloudMysqlInstanceStatusName; Cloud DB for MySQLインスタンスのステータス名
-creating
-deleted
-deleting
-pending
-recovering
-reinstalling
-restarting
-running
-settingup
-shuttingdown
-stopped
-upgrading
-downgrading
private CommonCode cloudMysqlInstanceStatus; Cloud DB for MySQLインスタンスのステータスコード
-INIT (init)
-CREAT (created)
-DEL (deleted)
private CommonCode cloudMysqlInstanceOperation; Cloud DB for MySQLインスタンスの Operationコード
-CREAT (create)
-DEL (delete)
-FO (failover)
-NULL (no)
-SETUP (setup)
-UPGD (upgrade)
-DWGD (downgrade)
-BKP (backup)
private String cloudMysqlImageProductCode; Cloud DB for MySQLイメージ商品コード
private String engineVersion; Cloud DB for MySQLエンジンバージョン
private CommonCode license; Cloud DB for MySQLライセンス
private Integer cloudMysqlPort; Cloud DB for MySQLポート
private Boolean isHa; 高可用性の有無
private Boolean isMultiZone; マルチゾーンの有無
private Boolean isBackup; バックアップの有無
private Integer backupFileRetentionPeriod; バックアップファイルの保管期間
private String backupTime; バックアップ時間
private String generationCode; サーバの世代コード
private Date createDate; 作成日
private List<String> accessControlGroupNoList; ACG番号リスト
private List<String> cloudMysqlConfigList; Cloud DB for MySQL Configリスト
private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList; Cloud DB for MySQLサーバインスタンスリスト
  • CloudMysqlServerInstanceタイプ
CloudMysqlServerInstance 説明
private String cloudMysqlServerInstanceNo; Cloud DB for MySQLサーバインスタンス番号
private String cloudMysqlServerName; Cloud DB for MySQLサーバ名
private CommonCode cloudMysqlServerRole; Cloud DB for MySQLサーバのロール
private String cloudMysqlServerInstanceStatusName; Cloud DB for MySQLサーバインスタンスのステータス名
-creating
-deleted
-deleting
-downgrading
-pending
-recovering
-reinstalling
-restarting
-running
-settingup
-shuttingdown
-stopped
-upgrading
-downgrading
private CommonCode cloudMysqlServerInstanceStatus; Cloud DB for MySQLサーバインスタンスのステータスコード
-DEL (deleted)
-PEND (pending)
-RUN (running)
-STOP (stopped)
-FSTOP (failure stopped)
private CommonCode cloudMysqlServerInstanceOperation; Cloud DB for MySQLサーバインスタンスの Operationコード
-NOOP (no operation)
-CREAT (create)
-START (start)
-RSTRT (restart)
-SETUP (setup)
-STOP (stop)
-FO (failover)
-DEL (delete)
-UPGD (upgrade)
-DWGD (downgrade)
-RISTL(サーバ reinstall)
-MIG (migration)
private String cloudMysqlProductCode; Cloud DB for MySQL商品コード
private String regionCode; リージョンコード
private String zoneCode; ZONEコード
private String vpcNo; VPC番号
private String subnetNo; Subnet番号
private Boolean isPublicSubnet; Public Subnetかどうか
private String publicDomain; グローバルドメイン名
private String privateDomain; プライベートドメイン名
private String privateIp; 内部 IPアドレス
private CommonCode dataStorageType; データストレージタイプ
private Boolean isStorageEncryption; データストレージ暗号化の有無
private Long dataStorageSize; データストレージ容量
private Long usedDataStorageSize; 使用中のデータストレージ容量
private Integer cpuCount; virtual CPU数
private Long memorySize; メモリ容量
private Date uptime; VM Booting完了時間
private Date createDate; 作成日

例

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

呼び出し例

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

ncloud vmysql getCloudMysqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMysqlServiceName test-**** --cloudMysqlInstanceNoList ****890 --cloudMysqlServerName test-**** --cloudMysqlServerInstanceNoList ****891 --generationCode G2 --pageNo 0 --pageSize 10

レスポンス例

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

レスポンス結果のフォーマットタイプ(output)が jsonの場合

{
  "getCloudMysqlInstanceListResponse": {
    "requestId": "1ae10c76-412d-4050-8911-42fa19a60a31",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMysqlInstanceList": {
      "cloudMysqlInstance": {
        "cloudMysqlInstanceNo": "****890",
        "cloudMysqlServiceName": "test-****",
        "cloudMysqlInstanceStatusName": "running",
        "cloudMysqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMysqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "isHa": true,
        "isMultiZone": true,
        "generationCode": "G2",
        "cloudMysqlServerInstanceList": {
          "cloudMysqlServerInstance": [
            {
              "cloudMysqlServerInstanceNo": "****891",
              "cloudMysqlServerName": "test-****-001-e04",
              "cloudMysqlServerRole": {
                "code": "M",
                "codeName": "Master"
              },
              "cloudMysqlServerInstanceStatusName": "running",
              "cloudMysqlServerInstanceStatus": {
                "code": "RUN",
                "codeName": "CLOUD DATABASE(VPC) Server Running State"
              },
              "cloudMysqlServerInstanceOperation": {
                "code": "NOOP",
                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
              },
              "privateIp": "***.***.***.***",
              "regionCode": "KR",
              "zoneCode": "KR-1",
              "vpcNo": "****83",
              "subnetNo": "****91",
              "dataStorageSize": 10737418240,
              "cpuCount": 2,
              "memorySize": 8589934592
            },
            {
              "cloudMysqlServerInstanceNo": "****897",
              "cloudMysqlServerName": "test-****-002-e05",
              "cloudMysqlServerRole": {
                "code": "H",
                "codeName": "Standby Master"
              },
              "cloudMysqlServerInstanceStatusName": "running",
              "cloudMysqlServerInstanceStatus": {
                "code": "RUN",
                "codeName": "CLOUD DATABASE(VPC) Server Running State"
              },
              "cloudMysqlServerInstanceOperation": {
                "code": "NOOP",
                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
              },
              "privateIp": "***.***.***.***",
              "regionCode": "KR",
              "zoneCode": "KR-2",
              "vpcNo": "****83",
              "subnetNo": "****93",
              "dataStorageSize": 10737418240,
              "cpuCount": 2,
              "memorySize": 8589934592
            }
          ]
        }
      }
    }
  }
}

レスポンス結果のフォーマットタイプ(output)が xmlの場合


<getCloudMysqlInstanceListResponse>
    <requestId>1ae10c76-412d-4050-8911-42fa19a60a31</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMysqlInstanceList>
        <cloudMysqlInstance>
            <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
            <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
            <cloudMysqlInstanceStatusName>running</cloudMysqlInstanceStatusName>
            <cloudMysqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudMysqlInstanceStatus>
            <cloudMysqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudMysqlInstanceOperation>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <generationCode>G2</generationCode>
            <cloudMysqlServerInstanceList>
                <cloudMysqlServerInstance>
                    <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
                    <cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
                    <cloudMysqlServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudMysqlServerRole>
                    <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                    <cloudMysqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMysqlServerInstanceStatus>
                    <cloudMysqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMysqlServerInstanceOperation>
                    <privateIp>***.***.***.***</privateIp>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                </cloudMysqlServerInstance>
                <cloudMysqlServerInstance>
                    <cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
                    <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
                    <cloudMysqlServerRole>
                        <code>H</code>
                        <codeName>Standby Master</codeName>
                    </cloudMysqlServerRole>
                    <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                    <cloudMysqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMysqlServerInstanceStatus>
                    <cloudMysqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMysqlServerInstanceOperation>
                    <privateIp>***.***.***.***</privateIp>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****93</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                </cloudMysqlServerInstance>
            </cloudMysqlServerInstanceList>
        </cloudMysqlInstance>
    </cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>