getCloudPostgresqlInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

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

リクエスト

リクエストパラメータ

パラメータ	タイプ	要否	説明	制約事項
regionCode	String	N	リージョンコード - regionCodeは、getRegionListアクションを通じて取得する - default: 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アクションを通じて取得する - ex) cloudPostgresqlInstanceNoList.1=1234&cloudPostgresqlInstanceNoList.2=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アクションを通じて取得する - ex) cloudPostgresqlServerInstanceNoList.1=1234&cloudPostgresqlServerInstanceNoList.2=2345	-
pageNo	Integer	N	ページングされた結果のページ番号 - 結果値を、pageNo、pageSizeを利用してページング処理できる	- Min: 0
pageSize	Integer	N	ページング時に表示する各ページサイズ - 結果値を、pageNo、pageSizeを利用してページング処理できる - pageNo入力時、必ず入力する	- Min: 1
responseFormatType	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: xml	-

レスポンス

レスポンスボディ

レスポンスボディは、CloudPostgresqlInstanceListをご参照ください。

例

リクエスト例

リクエスト構文例は次のとおりです。

GET {API_URL}/getCloudPostgresqlInstanceList
?regionCode=KR

レスポンス例

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

レスポンス結果のフォーマットタイプ(responseFormatType)が 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"
        },
        "isHa": true,
        "isMultiZone": true,
        "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",
            "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",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ]
  }
}

レスポンス結果のフォーマットタイプ(responseFormatType)が 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>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <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>
                    <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>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</getCloudPostgresqlInstanceListResponse>

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

What's Next

getCloudPostgresqlProductList

リクエスト
レスポンス
例

タグ

Cloud DB for PostgreSQL