getCloudMysqlInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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アクションを通じて取得できる - default: getRegionList照会結果の最初のリージョンを選択	-
zoneCode	String	N	ZONEコード - getZoneListアクションを通じて取得できる	-
vpcNo	String	Y	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	サーバ世代コード - options: G2 \| G3	-
pageNo	Integer	N	ページングされた結果のページ番号 - 結果値を、pageNo、pageSizeを利用してページング処理可能	min: 0
pageSize	Integer	N	ページング時に表示する各ページサイズ - 結果値を、pageNo、pageSizeを利用してページング処理可能 - pageNoを入力する際に必ず入力	min: 1
output	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: 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 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"
              },
              "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"
              },
              "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>
                    <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>
                    <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>

この記事は役に立ちましたか?

What's Next

getCloudMysqlProductList

コマンド
レスポンス
例

タグ