createCloudRedisInstance
- 印刷する
- PDF
createCloudRedisInstance
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Cloud DB for Redisインスタンスを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /createCloudRedisInstance |
リクエストヘッダ
Cloud DB for Redis APIで共通して使用されるヘッダの詳細は、Cloud DB for Redisのリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | 作成対象の Cloud DB for Redisインスタンスのリージョンコード
|
vpcNo | String | Required | Cloud DB for Redisインスタンス作成対象の VPC番号 |
cloudRedisImageProductCode | String | Optional | Cloud DB for Redisイメージ商品コード
|
cloudRedisProductCode | String | Optional | Cloud DB for Redis商品コード
|
shardCount | Integer | Optional | Redisモードが Clusterの場合、Master Nodeの作成数
|
shardCopyCount | Integer | Optional | Redis モードが Clusterの場合、Master Nodeのレプリカの Slave nodeの作成数
|
isHa | Boolean | Optional | 高可用性の有無
|
configGroupNo | String | Required | Config Group番号
|
isBackup | Boolean | Optional | Redisのバックアップ設定の有無
|
backupFileRetentionPeriod | Integer | Optional | バックアップファイルの保管期間(日)
|
backupTime | String | Conditional | バックアップ時点を設定
|
isAutomaticBackup | Boolean | Optional | バックアップ時点を自動設定するかどうか
|
cloudRedisServiceName | String | Required | 作成する Cloud DB for Redisサービスの名前
|
cloudRedisServerNamePrefix | String | Required | 作成する Cloud DB for Redisサーバ名の接頭辞
|
cloudRedisPort | Integer | Optional | Cloud DB for Redisインスタンスアクセス用の TCPポート番号
|
subnetNo | String | Required | 作成対象の Cloud Redisインスタンスの Subnet番号
|
engineVersionCode | String | Conditional | Redisエンジンのバージョン
|
cloudRedisModeCode | String | Required | 作成する Cloud DB for Redisモード
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/createCloudRedisInstance
?regionCode=KR
&vpcNo=****83
&cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.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'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、CloudRedisInstanceListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
responseFormatType=json
の場合
{
"createCloudRedisInstanceResponse": {
"totalRows": 1,
"cloudRedisInstanceList": [
{
"cloudRedisInstanceNo": "****511",
"cloudRedisServiceName": "test-****",
"cloudRedisInstanceStatusName": "creating",
"cloudRedisInstanceStatus": {
"code": "INIT",
"codeName": "CLOUD DATABASE(VPC) Init State"
},
"cloudRedisInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Creat OP"
},
"cloudRedisImageProductCode": "SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050",
"engineVersion": "REDIS 7.0.15",
"licence": {
"code": "BSD",
"codeName": "Berkeley Software Distribution"
},
"cloudRedisPort": 6379,
"isHa": true,
"cloudRedisServerPrefix": "test-****",
"generationCode": "G2",
"role": {
"code": "CLUSTER",
"codeName": "CLOUD REDIS(VPC) Cluster Role"
},
"createDate": "2024-07-01T16:59:21+0900",
"accessControlGroupNoList": [],
"masterNodeCount": 3,
"slaveNodeCount": 3,
"configGroupNo": "***9",
"configGroupName": "test-***-config",
"cloudRedisServerInstanceList": [
{
"cloudRedisServerName": "test-****-001-001-ehd",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "***83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudRedisServerName": "test-****-002-001-ehe",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudRedisServerName": "test-****-003-001-ehf",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudRedisServerName": "test-****-001-002-ehg",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudRedisServerName": "test-****-002-002-ehh",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
},
{
"cloudRedisServerName": "test-****-003-002-ehi",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "creating",
"cloudRedisServerInstanceStatus": {
"code": "PEND",
"codeName": "CLOUD DATABASE(VPC) Server Pending State"
},
"cloudRedisServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Server Create OP"
},
"cloudRedisProductCode": "SVR.VRDS.STAND.C004.M001.NET.SSD.B050.G002",
"regionCode": "KR",
"vpcNo": "****83",
"subnetNo": "****91",
"privateDomain": "redisc-*****-vpc-cdb.ntruss.com",
"cpuCount": 4,
"memorySize": 1610612736,
"osMemorySize": 2147483648,
"createDate": "2024-07-01T16:59:21+0900"
}
]
}
],
"requestId": "6aaac383-****-****-****-e7b07eea5c35",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml
(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<createCloudRedisInstanceResponse>
<requestId>6aaac383-****-****-****-e7b07eea5c35</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.0708.REDIS.7015.B050</cloudRedisImageProductCode>
<engineVersion>REDIS 7.0.15</engineVersion>
<licence>
<code>BSD</code>
<codeName>Berkeley Software Distribution</codeName>
</licence>
<cloudRedisPort>6379</cloudRedisPort>
<isHa>true</isHa>
<cloudRedisServerPrefix>test-****</cloudRedisServerPrefix>
<generationCode>G2</generationCode>
<role>
<code>CLUSTER</code>
<codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
</role>
<createDate>2024-07-01T16:59:21+0900</createDate>
<accessControlGroupNoList/>
<masterNodeCount>3</masterNodeCount>
<slaveNodeCount>3</slaveNodeCount>
<configGroupNo>***9</configGroupNo>
<configGroupName>test-***-config</configGroupName>
<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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+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>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
<osMemorySize>2147483648</osMemorySize>
<createDate>2024-07-01T16:59:21+0900</createDate>
</cloudRedisServerInstance>
</cloudRedisServerInstanceList>
</cloudRedisInstance>
</cloudRedisInstanceList>
</createCloudRedisInstanceResponse>
この記事は役に立ちましたか?