createCloudRedisInstance
    • PDF

    createCloudRedisInstance

    • PDF

    Article Summary

    VPC環境で利用できます。

    概要

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

    リクエスト

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    regionCodeNoString- リージョンコード
    Cloud DB for Redisのインスタンスを作成するリージョン(Region)を決定可能
    regionCodeは、getRegionListアクションを通じて取得可能
    Default: getRegionList照会結果の最初のリージョンを選択
    vpcNoYesString- VPC番号
    Cloud DB for Redisインスタンスが作成する VPCを決定
    vpcNoは、getVpcListアクションを通じて取得可能
    cloudRedisImageProductCodeNoString- Cloud Redisイメージのサービスコード
    cloudRedisImageProductCodeは、getCloudRedisImageProductListアクションの productCodeで取得可能
    入力がない場合は、Default値で作成
    cloudRedisProductCodeNoString- Cloud Redisのサービスコード
    作成する Cloud DB for Redisのインスタンスのサーバスペックを決定可能
    cloudRedisProductCodeは、getCloudRedisProductListアクションの productCodeで取得可能
    Default: 最小スペックを選択
    最小スペックの基準は、1. メモリ、2. CPU
    shardCountNoIntegerMin:3, Max: 10- シャード数
    作成するシャード数
    最小3個、最大10個
    Master Node数
    CloudRedisModeCodeが CLUSTERの場合にのみ入力
    CloudRedisModeCodeが SIMPLEの場合、shardCountが入力されても無視される
    default: 3
    shardCopyCountNoIntegerMin: 0, Max: 4- シャード当たりのコピー
    Redis Clusterは、Master nodeと Slave nodeで構成されている
    HAには Slave nodeが必要
    コピーを追加する際、すべての Masterノードにそれぞれ1つずつ Slave nodeが割り当てられる
    例) シャード数3、シャード当たりのコピー1 -> Master node: 3台、Slave node: 3台
    シャード当たりのコピーは0~4まで入力可能
    シャード当たりのコピーを0に設定する場合、高可用性には対応しない
    CloudRedisModeCodeが CLUSTERの場合にのみ入力
    CloudRedisModeCodeが SIMPLEの場合、shardCopyCountが入力されても無視される
    default: 0
    isHaNoBoolean- 高可用性の有無
    Cloud DB for Redisは Standbyマスターを利用した自動障害復旧をサポート
    高可用性をサポートすると追加料金が発生し、自動的にバックアップを設定
    Default: false
    configGroupNoYesString- ConfigGroup番号
    Config Groupが提供され、1つのクラスタ群はすべて同じ configを使用することになる
    Config Groupがない場合は新しく作成する必要があり、作成後もオンラインで変更可能
    isBackupNoBoolean- バックアップの有無
    高可用性の有無(isHa)が Trueの場合、バックアップ設定の有無も Trueに固定される
    default : false
    backupFileRetentionPeriodNoIntegerMin: 1, Max: 7- バックアップファイルの保存期間
    バックアップは毎日行われ、バックアップファイルは別途のバックアップストレージに保存
    料金は使用する容量だけ課金
    Default: 1(1日)
    backupTimeConditionalString- バックアップ時間
    バックアップが実行される時間を設定
    バックアップの有無(isBackup)が Trueで、自動バックアップの有無(isAutomaticBackup)が Falseの場合は必ず入力
    ユースケース
    01:15
    isAutomaticBackupNoBoolean- バックアップ時間の自動有無
    自動でバックアップ時間の設定の有無を選択
    自動バックアップの有無(isAutomaticBackup)が Trueの場合、backupTimeが入力されても無視されて自動設定される
    cloudRedisServiceNameYesString英数字、記号「-」、ハングルのみ入力可能
    Min: 3, Max: 15
    - Cloud Redisのサービス名
    Redis Serverのグループ名を入力(例: NAVER-HOME)
    3~15文字で入力可能
    Redisサービス名は重複使用不可
    cloudRedisServerNamePrefixYesString英小文字、数字、ハイフン(-)のみで構成すること
    先頭は英字に、末尾は英字または数字にすること
    Min: 3, Max: 15
    - Cloud Redisのサーバ名
    Redis Server名の Prefixを入力
    3~15桁で入力可能
    Redis Server名に3桁の数字が自動採番されて作成される
    Redis Server名は重複使用不可
    cloudRedisPortNoInteger6379
    or
    Min: 10000, Max: 20000
    - Cloud Redisポート
    Redisアクセスのための TCPポート番号を入力必要
    Default: 6379
    subnetNoYesString- Subnet番号
    作成する Cloud Redisインスタンスの Subnetを決定
    SubnetNoは、getSubnetListアクションを通じて取得可能
    Publicドメインは、Public Subnetに作成された DBサーバでのみご利用の申し込み可能
    Cloud DB for Redisインスタンス作成後、Subnetは移行不可
    engineVersionCodeNoString- Engine Version
    getCloudRedisImageProductListは、getCloudRedisImageProductListアクションを通じて取得可能
    cloudRedisImageProductCodeの generationCodeが G3の場合に入力
    入力しない場合、現在提供中の最新バージョンで作成
    cloudRedisModeCodeYesString- Cloud DB for Redisの構成
    Cloud DB for Redisの構成を決定
    CLUSTER設定使用時、isHa設定を無視
    Options: CLUSTER, SIMPLE
    responseFormatTypeNoString- レスポンス結果のフォーマットタイプ
    Options: xml | json
    Default: xml

    レスポンス

    レスポンスボディ

    リクエスト例

    GET {API_URL}/createCloudRedisInstance
    ?regionCode=KR
    &vpcNo=****83
    &cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050
    &cloudRedisProductCode=SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002
    &shardCount=3
    &shardCopyCount=1
    &isHa=true
    &configGroupNo=**9
    &isBackup=true
    &backupFileRetentionPeriod=7
    &backupTime=00:15
    &isAutomaticBackup=true
    &cloudRedisServiceName=test-****
    &cloudRedisServerNamePrefix=test-****
    &cloudRedisPort=6379
    &subnetNo=****91
    &cloudRedisModeCode=CLUSTER
    

    レスポンス例

    
    <createCloudRedisInstanceResponse>
        <requestId>0a3318fc-7176-4e2d-8c55-925209e53115</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudRedisInstanceList>
            <cloudRedisInstance>
                <cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
                <cloudRedisServiceName>test-*****</cloudRedisServiceName>
                <cloudRedisInstanceStatusName>creating</cloudRedisInstanceStatusName>
                <cloudRedisInstanceStatus>
                    <code>INIT</code>
                    <codeName>CLOUD DATABASE(VPC) Init State</codeName>
                </cloudRedisInstanceStatus>
                <cloudRedisInstanceOperation>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
                </cloudRedisInstanceOperation>
                <cloudRedisImageProductCode>SW.VDBAS.VRDS.LNX64.CNTOS.0703.REDIS.4014.B050</cloudRedisImageProductCode>
                <engineVersion>REDIS 4.0.14</engineVersion>
                <licence>
                    <code>BSD</code>
                    <codeName>Berkeley Software Distribution</codeName>
                </licence>
                <cloudRedisPort>6379</cloudRedisPort>
                <isHa>false</isHa>
                <cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
                <role>
                    <code>CLUSTER</code>
                    <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
                </role>
                <createDate>2021-04-21T15:05:31+0900</createDate>
                <masterNodeCount>3</masterNodeCount>
                <slaveNodeCount>3</slaveNodeCount>
                <configGroupNo>**9</configGroupNo>
                <configGroupName>test-****-config</configGroupName>
                <generationCode>G2</generationCode>
                <cloudRedisServerInstanceList>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-001-001-ehd</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-002-001-ehe</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-003-001-ehf</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-001-002-ehg</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-002-002-ehh</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                    <cloudRedisServerInstance>
                        <cloudRedisServerName>test-****-003-002-ehi</cloudRedisServerName>
                        <cloudRedisServerRole>
                            <code>S</code>
                            <codeName>Slave</codeName>
                        </cloudRedisServerRole>
                        <cloudRedisServerInstanceStatusName>creating</cloudRedisServerInstanceStatusName>
                        <cloudRedisServerInstanceStatus>
                            <code>PEND</code>
                            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                        </cloudRedisServerInstanceStatus>
                        <cloudRedisServerInstanceOperation>
                            <code>CREAT</code>
                            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                        </cloudRedisServerInstanceOperation>
                        <cloudRedisProductCode>SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002</cloudRedisProductCode>
                        <regionCode>KR</regionCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                        <osMemorySize>2147483648</osMemorySize>
                        <createDate>2021-04-21T15:05:31+0900</createDate>
                    </cloudRedisServerInstance>
                </cloudRedisServerInstanceList>
            </cloudRedisInstance>
        </cloudRedisInstanceList>
    </createCloudRedisInstanceResponse>
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.