getCloudMssqlInstanceList

VPC環境で利用できます。

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

コマンド

コマンド構文は、次のとおりです。

ncloud vmssql getCloudMssqlInstanceList [cloudMssqlInstanceNoList] [cloudMssqlServiceName] [cloudMssqlServerInstanceNoList] [cloudMssqlServerName] [regionCode] [zoneCode] [vpcNo] [subnetNo] [pageNo] [pageSize] [output]

パラメータ

パラメータについての説明は、次のとおりです。

パラメータ	タイプ	要否	説明	制約事項
cloudMssqlInstanceNoList	List<String>	N	Cloud DB for MSSQLインスタンス番号リスト - Cloud DB for MSSQLインスタンス番号でフィルタリングして検索可能 - cloudMssqlInstanceNoListは、getCloudMssqlInstanceListアクションを通じて取得 - ex) cloudMssqlInstanceNoList 1234 2345	-
cloudMssqlServiceName	String	N	Cloud DB for MSSQLサービス名 - Cloud DB for MSSQLサービス名でィルタリングして検索可能 - cloudMssqlServiceNameは、getCloudMssqlInstanceListアクションを通じて取得	-
cloudMssqlServerInstanceNoList	List<String>	N	Cloud DB for MSSQLサーバインスタンス番号リスト - Cloud DB for MSSQLサーバインスタンス番号でフィルタリングして検索可能 - cloudMssqlServerInstanceNoList getCloudMssqlInstanceListアクションを通じて取得 - ex) cloudMssqlServerInstanceNoList 1234 2345	-
cloudMssqlServerName	String	N	Cloud DB for MSSQLサーバ名 - Cloud DB for MSSQLサーバ名でィルタリングして検索可能 - cloudMssqlServerNameは、getCloudMssqlInstanceListアクションを通じて取得	-
regionCode	String	N	リージョンコード - regionCodeは、getRegionListアクションを通じて取得 - default: getRegionList照会結果の最初のリージョンを選択	-
zoneCode	String	N	Zoneコード - zoneCodeは、getZoneListアクションを通じて取得	-
vpcNo	String	N	VPC番号 - vpcNoは、getCloudMssqlTargetVpcListアクションを通じて取得	-
subnetNo	String	N	Subnet番号 - SubnetNoは、getCloudMssqlTargetSubnetListアクションを通じて取得	-
pageNo	Integer	N	ページングされた結果のページ番号 - 結果値を、pageNo、pageSizeを利用してページング処理可能	- Min: 0
pageSize	Integer	N	ページング時に表示する各ページサイズ - 結果値を、pageNo、pageSizeを利用してページング処理可能 - pageNoを入力する際に必ず入力	- Min: 1
output	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: json	-

レスポンス

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

CloudMssqlInstanceListタイプ

CloudMssqlInstanceList extends CommonResponse	説明
private Integer totalRows;	照会されたリストの総数
private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>();	Cloud DB for MSSQLインスタンスリスト

CloudMssqlInstanceタイプ

CloudMssqlInstance	説明
private String cloudMssqlInstanceNo;	Cloud DB for MSSQLインスタンス番号
private String cloudMssqlServiceName;	Cloud DB for MSSQLサービス名
private String cloudMssqlInstanceStatusName;	Cloud DB for MSSQLインスタンスステータス名 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading`
private CommonCode cloudMssqlInstanceStatus;	Cloud DB for MSSQLインスタンスステータスコード - `INIT (initiate)` - `CREAT (created)` - `DEL (deleted)`
private CommonCode cloudMssqlInstanceOperation;	Cloud DB for MSSQLインスタンス Operationコード - `CREAT (create)` - `DEL (delete)` - `FO (failover)` - `NULL (no operation)` - `SETUP (setup)` - `UPGD (upgrade)` - `DWGD (downgrade)` - `BKP (backup)` - `FW (Failover waiting)`
private String cloudMssqlImageProductCode;	Cloud DB for MSSQLイメージ商品コード
private Boolean isHa;	高可用性の有無
private Boolean isMultiZone;	マルチゾーンの有無
private CommonCode license;	Cloud DB for MSSQLライセンス
private Integer cloudMssqlPort;	Cloud DB for MSSQLポート
private Integer backupFileRetentionPeriod;	バックアップファイルの保存期間
private String backupTime;	バックアップ時間
private String configGroupNo;	Cloud DB for MSSQL Config Group番号
private String configGroupName;	Cloud DB for MSSQL Config Group名
private String engineVersion;	Cloud DB for MSSQLエンジンバージョン
private Date createDate;	作成日
private String dbCollation;	Cloud DB for MSSQLキャラクターセット
private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList;	Cloud DB for MSSQLサーバインスタンスリスト
private AccessControlGroupNoList accessControlGroupNoList;	ACG番号リスト

CloudMssqlServerInstanceタイプ

CloudMssqlServerInstance	説明
private String cloudMssqlServerInstanceNo;	Cloud DB for MSSQLサーバインスタンス番号
private String cloudMssqlServerName;	Cloud DB for MSSQLサーバ名
private CommonCode cloudMssqlServerRole;	Cloud DB for MSSQLサーバーの役割
private String cloudMssqlServerInstanceStatusName;	Cloud DB for MSSQLサーバインスタンスステータス名 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading` - `downgrading`
private CommonCode cloudMssqlServerInstanceStatus;	Cloud DB for MSSQLサーバインスタンスステータスコード - `DEL (deleted)` - `PEND (pending)` - `RUN (running)` - `STOP (stopped)` - `FSTOP (failure stopped)`
private CommonCode cloudMssqlServerInstanceOperation;	Cloud DB for MSSQLサーバインスタンス Operationコード - `NOOP (no operation)` - `CREAT (create)` - `START (start)` - `RSTRT (restart)` - `SETUP (setup)` - `STOP (stop)` - `FO (failover)` - `DEL (delete)` - `UPGD (upgrade)` - `DWGD (downgrade)` - `RISTL (reinstall)`
private String regionCode;	リージョンコード
private String zoneCode;	Zoneコード
private String vpcNo;	VPC番号
private String subnetNo;	Subnet番号
private Long dataStorageSize;	データストレージサイズ
private Integer cpuCount;	CPU数
private Long memorySize;	メモリサイズ
private Boolean isPublicSubnet;	Public Subnetの有無
private String cloudMssqlProductCode;	Cloud DB for MSSQL商品コード
private String privateDomain;	プライベートドメイン名
private String publicDomain;	グローバルドメイン名
private Date createDate;	作成日
private Date uptime;	VM起動完了時間
private CommonCode dataStorageType;	データストレージタイプ
private Long usedDataStorageSize;	使用中のデータストレージサイズ

AccessControlGroupNoListタイプ

AccessControlGroupNoList 説明

private List<String> accessControlGroupNoList = new ArrayList<>(); ACG番号リスト

AccessControlGroupNoList	説明
private List<String> accessControlGroupNoList = new ArrayList<>();	ACG番号リスト

例

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

呼び出し例

呼び出し例は、次のとおりです。

ncloud vmssql getCloudMssqlInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***83 --subnetNo **91 --cloudMssqlServiceName test-**** --cloudMssqlInstanceNoList ****890 --cloudMssqlServerName test--**** --cloudMssqlServerInstanceNoList ****891 --pageNo 0 --pageSize 10

レスポンス例

レスポンス例は、次のとおりです。

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

レスポンス結果フォーマットタイプ(output)が jsonの場合は、次のとおりです。

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "*****90",
        "cloudMssqlServiceName": "******",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "******91",
            "cloudMssqlServerName": "*******001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          },
          {
            "cloudMssqlServerInstanceNo": "********",
            "cloudMssqlServerName": "*********002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "vpcNo": "*****",
            "subnetNo": "*****",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 8589934592
          }
        ]
      }
    ],
    "requestId": "*********************************",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

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

レスポンス結果フォーマットタイプ(responseFormatType)が xmlの場合は、次のとおりです。

<getCloudMssqlInstanceListResponse>
    <requestId>*********************************</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
      <cloudMssqlInstance>
        <cloudMssqlInstanceNo>*******</cloudMssqlInstanceNo>
        <cloudMssqlServiceName>*******</cloudMssqlServiceName>
        <cloudMssqlInstanceStatusName>running</cloudMssqlInstanceStatusName>
        <cloudMssqlInstanceStatus>
          <code>CREAT</code>
          <codeName>CLOUD DATABASE(VPC) Created State</codeName>
        </cloudMssqlInstanceStatus>
        <cloudMssqlInstanceOperation>
          <code>NULL</code>
          <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
        </cloudMssqlInstanceOperation>
        <cloudMssqlServerInstanceList>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>*******</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>*******</cloudMssqlServerName>
            <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
            <cloudMssqlServerInstanceStatus>
              <code>RUN</code>
              <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
            </cloudMssqlServerInstanceStatus>
            <cloudMssqlServerInstanceOperation>
              <code>NOOP</code>
              <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
            </cloudMssqlServerInstanceOperation>
            <vpcNo>*****</vpcNo>
            <subnetNo>*****</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
          <cloudMssqlServerInstance>
            <cloudMssqlServerInstanceNo>********</cloudMssqlServerInstanceNo>
            <cloudMssqlServerName>********</cloudMssqlServerName>
            <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName>
            <cloudMssqlServerInstanceStatus>
              <code>RUN</code>
              <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
            </cloudMssqlServerInstanceStatus>
            <cloudMssqlServerInstanceOperation>
              <code>NOOP</code>
              <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
            </cloudMssqlServerInstanceOperation>
            <vpcNo>*****</vpcNo>
            <subnetNo>******</subnetNo>
            <dataStorageSize>107374182400</dataStorageSize>
            <cpuCount>2</cpuCount>
            <memorySize>8589934592</memorySize>
          </cloudMssqlServerInstance>
        </cloudMssqlServerInstanceList>
      </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</getCloudMssqlInstanceListResponse>