createCloudRedisInstance

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用可能

概要

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

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
regionCode	No	String		- リージョンコード Cloud DB for Redisインスタンスが作成されるリージョン(Region) regionCodeはgetRegionListアクションを通じて取得可能デフォルト: getRegionList照会結果の最初のリージョンを選択
vpcNo	Yes	String		- VPC番号 Cloud DB for Redisインスタンスが作成される VPCを決める。 vpcNoはgetCloudRedisTargetVpcListアクションを通じて取得可能
cloudRedisImageProductCode	No	String		- Cloud Redisイメージ商品コード cloudRedisImageProductCodeはgetCloudRedisImageProductListアクションの productCodeで取得可能入力しない場合、デフォルト値で作成される。
cloudRedisProductCode	No	String		- Cloud Redis商品コード作成する Cloud DB for Redisインスタンスのサーバスペックを決定可能 cloudRedisProductCodeはgetCloudRedisProductListアクションの productCodeで取得可能デフォルト: 最低スペックが選択される。最低スペックの基準は、1. メモリ、2. CPU
shardCount	No	Integer	最小:3, 最大: 10	- シャード数作成するシャード数 3個から10個まで Master Nodeの数 CloudRedisModeCodeが CLUSTERの場合にのみ入力 CloudRedisModeCodeが SIMPLEの場合は、shardCountが入力されても無視されるデフォルト: 3
shardCopyCount	No	Integer	最小: 0, 最大: 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が入力されても無視される。デフォルト: 0
isHa	No	Boolean		- 高可用性の有無 Cloud DB for Redisサービスは、Standbyマスターを利用した自動障害復旧をサポート高可用性をサポートすると追加料金が発生し、自動的にバックアップが設定。デフォルト: false
configGroupNo	Yes	String		- Config Group番号 Config Groupが提供され、1つのクラスタ群はすべて同じ configを使用することになる。 Config Groupがない場合は新しく作成する必要があり、作成後はオンラインで変更可能
isBackup	No	Boolean		- バックアップの有無高可用性の有無(isHa)が Trueの場合、バックアップ設定の有無も Trueに固定される。デフォルト: false
backupFileRetentionPeriod	No	Integer	最小: 1, 最大: 7	- バックアップファイルの保管期間バックアップは毎日行われ、バックアップファイルは別途のバックアップストレージに保存される。料金は使用する容量だけ課金される。デフォルト: 1(1日)
backupTime	Conditional	String		- バックアップ時間バックアップが実行される時間を設定バックアップの有無(isBackup)が Trueで、自動バックアップの有無(isAutomaticBackup)が Falseの場合、必ず入力例 01:15
isAutomaticBackup	No	Boolean		- バックアップ時間の自動有無自動でバックアップ時間を設定するかどうかを選択。自動バックアップするかどうか(isAutomaticBackup)が Trueの場合、backupTimeが入力されても無視され、自動設定される。
cloudRedisServiceName	Yes	String	英数字、記号のハイフン「-」、ハングルのみ入力可能最小: 3, 最大: 15	- Cloud Redisサービス名 Redis Serverのグループ名を入力(例: NAVER-HOME) 3文字~15文字以内で入力可能。 Redisサービス名は重複して使用不可
cloudRedisServerNamePrefix	Yes	String	英字(小文字)、数字、ハイフン「-」のみ使用可能先頭文字は英字、末尾文字は英字または数字のみ使用最小: 3, 最大: 15	- Cloud Redisサーバ名 Redis Serverの名前 Prefixを入力 3文字~15文字以内で入力可能 Redis Server名に3桁の数字が自動採番されて作成される。Redis Server名は重複して使用不可
cloudRedisPort	No	Integer	6379 or 最小: 10000, 最大: 20000	- Cloud Redisポート Redisアクセス用 TCPポート番号を入力デフォルト: 6379
subnetNo	Yes	String		- Subnet番号作成する Cloud Redisインスタンスの Subnetを決める subnetNoはgetCloudRedisTargetSubnetListアクションを通じて取得可能 Publicドメインは Public Subnetに作成された DBサーバでのみ申し込み可能 Cloud DB for Redisインスタンス作成後に Subnetの移転はできない
engineVersionCode	No	String		- Engine Version getCloudRedisImageProductListはgetCloudRedisImageProductListアクションを通じて取得可能 cloudRedisImageProductCodeの generationCodeが G3の場合にのみ入力入力しない場合、現在提供中の最新バージョンで作成
cloudRedisModeCode	Yes	String		- Cloud DB for Redis構成 Cloud DB for Redisの構成を決める。
CLUSTER設定の使用時、isHa設定を無視。オプション: CLUSTER, SIMPLE
output	No	String		- レスポンス結果の形式タイプオプション: xml \| json デフォルト: json

レスポンス

レスポンスデータタイプ

CloudRedisInstanceListタイプ

CloudRedisInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudRedisInstance> cloudRedisInstanceList = new ArrayList<>();

CloudRedisInstance
private String cloudRedisInstanceNo;
private String cloudRedisServiceName;
private String cloudRedisInstanceStatusName;
private CommonCode cloudRedisInstanceStatus;
private CommonCode cloudRedisInstanceOperation;
private String cloudRedisImageProductCode;
private String engineVersion;
private CommonCode licence;
private Integer cloudRedisPort;
private Boolean isHa;
private String cloudRedisServerPrefix;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private String backupSchedule;
private String generationCode;
private Date createDate;
private Integer shardCount;
private Integer shardCopyCount;
private AccessControlGroupNoList accessControlGroupNoList;
private String configGroupNo;
private String configGroupName;
private CommonCode role;
private List<CloudRedisInstance> cloudRedisServerInstanceList;

AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();

CloudRedisServerInstance
private String cloudRedisServerInstanceNo;
private String cloudRedisServerName;
private CommonCode cloudRedisServerRole;
private String cloudRedisServerInstanceStatusName;
private CommonCode cloudRedisServerInstanceStatus;
private CommonCode cloudRedisServerInstanceOperation;
private String cloudRedisProductCode;
private String regionCode;
private String zoneCode;
private String vpcNo;
private String subnetNo;
private String privateDomain;
private Integer cpuCount;
private Long memorySize;
private Long osMemorySize;
private Date uptime;
private Date createDate;
private String slotName;

例

呼び出し

ncloud vredis 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>

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

What's Next

deleteCloudRedisConfigGroup

概要
リクエスト
レスポンス
例

タグ