createCloudPostgresqlInstance

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

Cloud DB for PostgreSQLインスタンスを作成します。

リクエスト

リクエストパラメータ

パラメータ	タイプ	要否	説明	制約事項
regionCode	String	N	リージョンコード - regionCodeは、getRegionListアクションを通じて取得する - default: getRegionList照会結果の最初のリージョンを選択する	-
vpcNo	String	Y	VPC番号 - vpcNoは、getCloudPostgresqlTargetVpcListアクションを通じて取得する	-
subnetNo	String	Y	Subnet番号 - subnetNoは、getCloudPostgresqlTargetSubnetListアクションを通じて取得する - Publicドメインは、Public Subnetに作成された DBサーバでのみご利用の申し込みができる - Cloud DB for PostgreSQLインスタンスの作成後に Subnetへの移行はできない	-
secondarySubnetNo	String	N	Secondaryサーバの Subnet番号 - マルチゾーンの有無(isMultiZone)が falseであれば入力せず、マルチゾーンの有無(isMultiZone)が trueであれば必ず入力する - Primaryサーバの Subnetと Zoneが異なる必要があり、同じ Publicか Privateである必要がある - secondarySubnetNoは、 getCloudPostgresqlTargetSubnetListアクションを通じて取得する	-
cloudPostgresqlImageProductCode	String	N	Cloud DB for PostgreSQLイメージ商品コード - cloudPostgresqlImageProductCodeは、getCloudPostgresqlImageProductListアクションの productCodeで取得する - 入力しない場合、Default値で作成する	-
cloudPostgresqlProductCode	String	N	Cloud DB for PostgreSQL商品コード - 作成する Cloud DB for PostgreSQLインスタンスのサーバスペックを決定する - cloudPostgresqlProductCodeは、getCloudPostgresqlProductListアクションの productCodeで取得する - default: 最小スペックで選択する。最小スペックの基準は、1. メモリ、2. CPU	-
dataStorageTypeCode	String	N	データストレージタイプコード - インストール後にデータストレージタイプの変更はできない - options: SSD \| HDD - default: SSD	-
isHa	Boolean	N	高可用性の有無 - 高可用性を選択すると、Secondaryサーバを含めて2台のサーバが作成され、追加料金が発生する - 高可用性の有無(isHa)が falseの場合、isMultiZone、secondarySubnetNoパラメータは使用できない - default: true	-
isMultiZone	Boolean	N	マルチゾーンの有無 - 高可用性の有無(isHa)が trueの場合、マルチゾーンの有無を選択できる - マルチゾーンを選択すると、Primaryサーバと Secondaryサーバを異なる Zoneに作成しより高い可用性を提供する - 高可用性の有無(isHa)が trueである場合、必ず入力する - Neurocloud環境では利用できない - default: false	-
isStorageEncryption	Boolean	N	データストレージ暗号化の適用有無 - 暗号化の適用時、DBデータは暗号化されストレージに保存される - Cloud DB for PostgreSQLインスタンス作成後にはストレージ暗号化の設定変更ができない - Neurocloud環境では利用できない - default: false	-
isBackup	Boolean	N	バックアップの有無 - 高可用性の有無(isHa)が trueの場合、バックアップの有無(isBackup)は trueに固定される - default: true	-
backupFileRetentionPeriod	Integer	N	バックアップファイルの保存期間 - バックアップは毎日行われバックアップファイルは別途のバックアップストレージに保存される - 料金は使用する容量だけ課金される - default: 1(1日)	-
backupTime	String	N	バックアップ時間 - バックアップの時間設定、バックアップの有無(isBackup)が trueで自動バックアップの有無(isAutomaticBackup)が falseの場合必ず入力する - 01:15	-
isAutomaticBackup	Boolean	N	バックアップ時間の自動有無 - 自動でバックアップ時間を設定するかどうかの選択、自動バックアップの有無(isAutomaticBackup)が trueの場合 backupTimeの入力はできない - default: true	-
cloudPostgresqlServiceName	String	Y	Cloud DB for PostgreSQLサービス名	- 英数字、ハイフン(-)、ハングルのみ入力可能 - Min: 3 - Max: 30
cloudPostgresqlServerNamePrefix	String	Y	Cloud DB for PostgreSQLサーバ名接頭辞 - ホスト名重複防止のため伝達された cloudPostgresqlServerNamePrefix値の後ろに任意の textが追加され作成される	- DB Server名はアルファベットの小文字、数字、ハイフン(-)でのみ構成できる - 最初の文字はアルファベットで、最後の文字はアルファベットまたは数字であること - Min: 3 - Max: 20
cloudPostgresqlUserName	String	Y	管理者 ID - DB管理者用として使用するユーザー名を入力する	- アルファベットの小文字、数字、アンダースコア( _ )のみ入力可能で、先頭文字はアルファベットにする - Min: 4 - Max: 16
cloudPostgresqlUserPassword	String	Y	管理者パスワード - DB管理者用として使用するユーザーのパスワードを入力する	- 8文字以上で、アルファベット、特殊文字、数字の3種類を1文字以上含む - & + \ " ' /とスペースはパスワードとして使用できない - User IDを含むことはできない - Min: 8 - Max: 20
clientCidr	String	Y	アクセス制御 - アクセスしようとする Clientの CIDRを入力する	- すべてのアクセスを許可: 0.0.0.0/0 - 特定の IPアクセスを許可: 192.168.1.1/32 - IP帯域アクセスを許可: 192.168.1.0/24
cloudPostgresqlPort	Integer	N	Cloud DB for PostgreSQLポート - PostgreSQLにアクセスするための TCPポート番号を入力する - default: 5432	5432 or - Min: 10000 - Max: 20000
cloudPostgresqlDatabaseName	String	Y	Cloud DB for PostgreSQLの DB名 - デフォルトとして作成する DB名を入力する	- アルファベットの小文字、数字、アンダースコア( _ )のみ入力可能で、先頭文字はアルファベットにする - Min: 1 - Max: 30
responseFormatType	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: xml	-

レスポンス

レスポンスボディ

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

例

リクエスト例

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

GET {API_URL}/createCloudPostgresqlInstance
?regionCode=KR
&vpcNo=****87
&subnetNo=****49
&secondarySubnetNo=****51
&cloudPostgresqlImageProductCode=SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050
&cloudPostgresqlProductCode=SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001
&dataStorageTypeCode=SSD
&isHa=true
&isMultiZone=true
&isStorageEncryption=true
&isBackup=true
&backupFileRetentionPeriod=10
&backupTime=02:00
&isAutomaticBackup=false
&cloudPostgresqlServiceName=test-****
&cloudPostgresqlServerNamePrefix=test-****
&cloudPostgresqlUserName=test****
&cloudPostgresqlUserPassword=********
&clientCidr=0.0.0.0/0
&cloudPostgresqlPort=15432
&cloudPostgresqlDatabaseName=test****

レスポンス例

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

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

{
  "createCloudPostgresqlInstanceResponse": {
    "requestId": "9f76fa24-67a4-4cdf-bf70-f62f251d5138",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlInstanceList": [
      {
        "cloudPostgresqlInstanceNo": "****925",
        "cloudPostgresqlServiceName": "test-****",
        "cloudPostgresqlInstanceStatusName": "creating",
        "cloudPostgresqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init State"
        },
        "cloudPostgresqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudPostgresqlImageProductCode": "SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050",
        "engineVersion": "PostgreSQL 13.3",
        "license": "PostgreSQL License",
        "cloudPostgresqlPort": 15432,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 10,
        "backupTime": "02:00",
        "createDate": "2021-09-16T18:00:00+0900",
        "accessControlGroupNoList": [],
        "cloudPostgresqlServerInstanceList": [
          {
            "cloudPostgresqlServerName": "test-****-001-gcb",
            "cloudPostgresqlServerRole": {
              "code": "M",
              "codeName": "Primary"
            },
            "cloudPostgresqlServerInstanceStatusName": "creating",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****87",
            "subnetNo": "****49",
            "isPublicSubnet": true,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2021-09-16T18:00:00+0900"
          },
          {
            "cloudPostgresqlServerName": "test-****-002-gcc",
            "cloudPostgresqlServerRole": {
              "code": "H",
              "codeName": "Secondary"
            },
            "cloudPostgresqlServerInstanceStatusName": "creating",
            "cloudPostgresqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudPostgresqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "cloudPostgresqlProductCode": "SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****87",
            "subnetNo": "****51",
            "isPublicSubnet": true,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "isStorageEncryption": true,
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "createDate": "2021-09-16T18:00:00+0900"
          }
        ]
      }
    ]
  }
}

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

<createCloudPostgresqlInstanceResponse>
    <requestId>9f76fa24-67a4-4cdf-bf70-f62f251d5138</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlInstanceList>
        <cloudPostgresqlInstance>
            <cloudPostgresqlInstanceNo>****925</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <cloudPostgresqlInstanceStatusName>creating</cloudPostgresqlInstanceStatusName>
            <cloudPostgresqlInstanceStatus>
                <code>INIT</code>
                <codeName>CLOUD DATABASE(VPC) Init State</codeName>
            </cloudPostgresqlInstanceStatus>
            <cloudPostgresqlInstanceOperation>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
            </cloudPostgresqlInstanceOperation>
            <cloudPostgresqlImageProductCode>SW.VPGSL.OS.LNX64.CNTOS.0708.PGSQL.133.B050</cloudPostgresqlImageProductCode>
            <engineVersion>PostgreSQL 13.3</engineVersion>
            <license>PostgreSQL License</license>
            <cloudPostgresqlPort>15432</cloudPostgresqlPort>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <isBackup>true</isBackup>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>02:00</backupTime>
            <createDate>2021-09-16T18:00:00+0900</createDate>
            <accessControlGroupNoList/>
            <cloudPostgresqlServerInstanceList>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-001-gcb</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>M</code>
                        <codeName>Primary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****49</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <createDate>2021-09-16T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
                <cloudPostgresqlServerInstance>
                    <cloudPostgresqlServerName>test-****-002-gcc</cloudPostgresqlServerName>
                    <cloudPostgresqlServerRole>
                        <code>H</code>
                        <codeName>Secondary</codeName>
                    </cloudPostgresqlServerRole>
                    <cloudPostgresqlServerInstanceStatusName>creating</cloudPostgresqlServerInstanceStatusName>
                    <cloudPostgresqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudPostgresqlServerInstanceStatus>
                    <cloudPostgresqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudPostgresqlServerInstanceOperation>
                    <cloudPostgresqlProductCode>SVR.VPGSL.DBSVR.STAND.C002.M004.NET.SSD.B050.G001</cloudPostgresqlProductCode>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****87</vpcNo>
                    <subnetNo>****51</subnetNo>
                    <isPublicSubnet>true</isPublicSubnet>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                    <isStorageEncryption>true</isStorageEncryption>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>4294967296</memorySize>
                    <createDate>2021-09-16T18:00:00+0900</createDate>
                </cloudPostgresqlServerInstance>
            </cloudPostgresqlServerInstanceList>
        </cloudPostgresqlInstance>
    </cloudPostgresqlInstanceList>
</createCloudPostgresqlInstanceResponse>

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

What's Next

createCloudPostgresqlReadReplicaInstance

リクエスト
レスポンス
例

タグ

Cloud DB for PostgreSQL