getCloudPostgresqlInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

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

コマンド

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

ncloud vpostgresql getCloudPostgresqlInstanceList [regionCode] [zoneCode] [vpcNo] [subnetNo] [cloudPostgresqlServiceName] [cloudPostgresqlInstanceNoList] [cloudPostgresqlServerName] [cloudPostgresqlServerInstanceNoList] [pageNo] [pageSize] [output]

パラメータ

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

パラメータ	タイプ	必須の有無	説明	制限事項
regionCode	String	N	リージョンコード - regionCodeはgetRegionListアクションを通じて取得 - デフォルト: getRegionList照会結果の最初のリージョンを選択	-
zoneCode	String	N	Zoneコード - zoneCodeは、getZoneListアクションを通じて取得	-
vpcNo	String	N	VPC番号 - vpcNoはgetCloudPostgresqlTargetVpcListアクションを通じて取得	-
subnetNo	String	N	Subnet番号 - SubnetNoはgetCloudPostgresqlTargetSubnetListアクションを通じて取得	-
cloudPostgresqlServiceName	String	N	Cloud DB for PostgreSQLサービス名 - Cloud DB for PostgreSQLサービス名でフィルタリングして検索可能 - cloudPostgresqlServiceNameはgetCloudPostgresqlInstanceListアクションを通じて取得	-
cloudPostgresqlInstanceNoList	List<String>	N	Cloud DB for PostgreSQLインスタンス番号リスト - Cloud DB for PostgreSQLインスタンス番号でフィルタリングして検索可能 - cloudPostgresqlInstanceNoListはgetCloudPostgresqlInstanceListアクションを通じて取得 - 例) cloudPostgresqlInstanceNoList 1234 2345	-
cloudPostgresqlServerName	String	N	Cloud DB for PostgreSQLサーバ名 - Cloud DB for PostgreSQLサーバ名でフィルタリングして検索可能 - cloudPostgresqlServerNameはgetCloudPostgresqlInstanceListアクションを通じて取得	-
cloudPostgresqlServerInstanceNoList	List<String>	N	Cloud DB for PostgreSQLサーバインスタンス番号リスト - Cloud DB for PostgreSQLサーバインスタンス番号でフィルタリングして検索可能 - cloudPostgresqlServerInstanceNoList getCloudPostgresqlInstanceListアクションを通じて取得 - 例) cloudPostgresqlServerInstanceNoList 1234 2345	-
pageNo	Integer	N	ページングされた結果のページ番号 - 結果値を pageNo、pageSizeを利用してページング処理できる	- 最小: 0
pageSize	Integer	N	ページング時に表示する各ページサイズ - 結果値を pageNo、pageSizeを利用してページング処理できる - pageNo入力時、必ず入力	- 最小: 1
output	String	N	レスポンス結果の形式タイプ - オプション: xml \| json - デフォルト: json	-

レスポンス

レスポンスデータタイプ

CloudPostgresqlInstanceListタイプ

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

CloudPostgresqlInstanceタイプ

CloudPostgresqlInstance	説明
private String cloudPostgresqlInstanceNo;	Cloud DB for PostgreSQLインスタンス番号
private String cloudPostgresqlServiceName;	Cloud DB for PostgreSQLサービス名
private String cloudPostgresqlInstanceStatusName;	Cloud DB for PostgreSQLインスタンスの状態名 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading`
private CommonCode cloudPostgresqlInstanceStatus;	Cloud DB for PostgreSQLインスタンスの状態コード - `INIT (initiate)` - `CREAT (created)` - `DEL (deleted)`
private CommonCode cloudPostgresqlInstanceOperation;	Cloud DB for PostgreSQLインスタンスの Operationコード - `CREAT (create)` - `DEL (delete)` - `FO (failover)` - `NULL (no operation)` - `SETUP (setup)` - `UPGD (upgrade)` - `DWGD (downgrade)` - `BKP (backup)`
private String cloudPostgresqlImageProductCode;	Cloud DB for PostgreSQLイメージ商品コード
private String engineVersion;	Cloud DB for PostgreSQLエンジンバージョン
private String generationCode;	世代コード
private String license;	Cloud DB for PostgreSQLライセンス
private Integer cloudPostgresqlPort;	Cloud DB for PostgreSQLポート
private Boolean isHa;	高可用性の有無
private Boolean isMultiZone;	マルチゾーンの有無
private Boolean isBackup;	バックアップの有無
private Integer backupFileRetentionPeriod;	バックアップファイルの保管期間
private String backupTime;	バックアップ時間
private Date createDate;	作成日
private AccessControlGroupNoList accessControlGroupNoList;	ACG番号リスト
private CloudPostgresqlConfigList cloudPostgresqlConfigList;	Cloud DB for PostgreSQL Configリスト
private List<CloudPostgresqlServerInstance> cloudPostgresqlServerInstanceList;	Cloud DB for PostgreSQLサーバインスタンスリスト

AccessControlGroupNoListタイプ

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

CloudPostgresqlConfigListタイプ

CloudPostgresqlConfigList	説明
private List<String> cloudPostgresqlConfigList = new ArrayList<>();	Cloud DB for PostgreSQL Configリスト

CloudPostgresqlServerInstanceタイプ

CloudPostgresqlServerInstance	説明
private String cloudPostgresqlServerInstanceNo;	Cloud DB for PostgreSQLサーバインスタンス番号
private String cloudPostgresqlServerName;	Cloud DB for PostgreSQLサーバ名
private CommonCode cloudPostgresqlServerRole;	Cloud DB for PostgreSQLサーバのロール
private String cloudPostgresqlServerInstanceStatusName;	Cloud DB for PostgreSQLサーバインスタンスの状態名 - `creating` - `deleted` - `deleting` - `downgrading` - `pending` - `recovering` - `reinstalling` - `restarting` - `running` - `settingup` - `shuttingdown` - `stopped` - `upgrading` - `downgrading`
private CommonCode cloudPostgresqlServerInstanceStatus;	Cloud DB for PostgreSQLサーバインスタンスの状態コード - `DEL (deleted)` - `PEND (pending)` - `RUN (running)` - `STOP (stopped)` - `FSTOP (failure stopped)`
private CommonCode cloudPostgresqlServerInstanceOperation;	Cloud DB for PostgreSQLサーバインスタンスの 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 cloudPostgresqlProductCode;	Cloud DB for PostgreSQL商品コード
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;	CPU数
private Long memorySize;	メモリ容量
private Date uptime;	VMの起動完了時間
private Date createDate;	作成日

例

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

呼び出し例

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

ncloud vpostgresql getCloudPostgresqlInstanceList --regionCode KR

レスポンス例

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

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

{
  "getCloudPostgresqlInstanceListResponse": {
    "requestId": "3c690190-a654-499e-8e00-7916d62ae416",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlInstanceList": [
      {
        "cloudPostgresqlInstanceNo": "****925",
        "cloudPostgresqlServiceName": "test-****",
        "cloudPostgresqlInstanceStatusName": "running",
        "cloudPostgresqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudPostgresqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "isHa": true,
        "isMultiZone": true,
        "cloudPostgresqlConfigList": [
            "sample_config=sample_value"
        ],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerInstanceNo": "****926",
            "cloudPostgresqlServerName": "test-****-001-gcb",
            "cloudPostgresqlServerRole": {
              "code": "M",
              "codeName": "Primary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****87",
            "subnetNo": "****49",
            "privateIp": "***.***.***.***",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "cloudPostgresqlServerInstanceNo": "****932",
            "cloudPostgresqlServerName": "test-****-002-gcc",
            "cloudPostgresqlServerRole": {
              "code": "H",
              "codeName": "Secondary"
            },
            "cloudPostgresqlServerInstanceStatusName": "running",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "privateIp": "***.***.***.***",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ]
  }
}

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

<getCloudPostgresqlInstanceListResponse>
    <requestId>3c690190-a654-499e-8e00-7916d62ae416</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlInstanceList>
        <cloudPostgresqlInstance>
            <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <cloudPostgresqlInstanceStatusName>running</cloudPostgresqlInstanceStatusName>
            <cloudPostgresqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudPostgresqlInstanceStatus>
            <cloudPostgresqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudPostgresqlInstanceOperation>
            <generationCode>G2</generationCode>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <cloudPostgresqlConfigList>
                <cloudPostgresqlConfig>sample_config=sample_value</cloudPostgresqlConfig>
            </cloudPostgresqlConfigList>
            <cloudPostgresqlServerInstanceList>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstanceNo>****926</cloudPostgresqlServerInstanceNo>
                    <cloudPostgresqlServerName>test-****-001-gcb</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>M</code>
                        <codeName>Primary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudPostgresqlServerInstance>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerInstanceNo>****932</cloudPostgresqlServerInstanceNo>
                    <cloudPostgresqlServerName>test-****-002-gcc</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>H</code>
                        <codeName>Secondary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>running</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <privateIp>***.***.***.***</privateIp>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceListResponse>

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

What's Next

getCloudPostgresqlProductList

コマンド
レスポンス
例

タグ