getCloudRedisInstanceDetail
- 인쇄
- PDF
getCloudRedisInstanceDetail
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
Cloud DB for Redis 인스턴스 상세 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET, POST | /getCloudRedisInstanceDetail |
요청 헤더
Cloud DB for Redis API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for Redis 요청 헤더를 참조해 주십시오.
요청 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
regionCode | String | Optional | 조회할 Cloud DB for Redis 인스턴스의 리전(Region) 코드
|
cloudRedisInstanceNo | String | Required | Cloud DB for Redis 인스턴스 번호
|
responseFormatType | String | Optional | 응답 결과의 형식
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisInstanceDetail
?regionCode=KR
&cloudRedisInstanceNo=****511'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디는 CloudRedisInstanceList를 참조해 주십시오.
응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
responseFormatType=json
일 때
{
"getCloudRedisInstanceDetailResponse": {
"totalRows": 1,
"cloudRedisInstanceList": [
{
"cloudRedisInstanceNo": "****511",
"cloudRedisServiceName": "test-****",
"cloudRedisInstanceStatusName": "running",
"cloudRedisInstanceStatus": {
"code": "CREAT",
"codeName": "CLOUD DATABASE(VPC) Created State"
},
"cloudRedisInstanceOperation": {
"code": "NULL",
"codeName": "CLOUD DATABASE(VPC) Null 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,
"isBackup": true,
"backupTime": "00:15",
"backupFileRetentionPeriod": 7,
"backupSchedule": "AUTO",
"cloudRedisServerPrefix": "test-****",
"generationCode": "G2",
"role": {
"code": "CLUSTER",
"codeName": "CLOUD REDIS(VPC) Cluster Role"
},
"createDate": "2024-07-01T16:59:21+0900",
"accessControlGroupNoList": [
"**50"
],
"masterNodeCount": 3,
"slaveNodeCount": 3,
"configGroupNo": "***9",
"configGroupName": "test-***-config",
"cloudRedisServerInstanceList": [
{
"cloudRedisServerInstanceNo": "****613",
"cloudRedisServerName": "test-****-001-001-ehs",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:03:43+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "0-5460"
},
{
"cloudRedisServerInstanceNo": "****616",
"cloudRedisServerName": "test-****-002-001-eht",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:04:10+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "5461-10922"
},
{
"cloudRedisServerInstanceNo": "****619",
"cloudRedisServerName": "test-****-003-001-ehu",
"cloudRedisServerRole": {
"code": "M",
"codeName": "Master"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:04:06+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "10923-16383"
},
{
"cloudRedisServerInstanceNo": "****622",
"cloudRedisServerName": "test-****-001-002-ehv",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:03:43+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "0-5460"
},
{
"cloudRedisServerInstanceNo": "****625",
"cloudRedisServerName": "test-****-002-002-ehw",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:03:42+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "5461-10922"
},
{
"cloudRedisServerInstanceNo": "****628",
"cloudRedisServerName": "test-****-003-002-ehx",
"cloudRedisServerRole": {
"code": "S",
"codeName": "Slave"
},
"cloudRedisServerInstanceStatusName": "running",
"cloudRedisServerInstanceStatus": {
"code": "RUN",
"codeName": "CLOUD DATABASE(VPC) Server Running State"
},
"cloudRedisServerInstanceOperation": {
"code": "NOOP",
"codeName": "CLOUD DATABASE(VPC) Server Null 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,
"uptime": "2024-07-01T17:03:47+0900",
"createDate": "2024-07-01T16:59:21+0900",
"slotName": "10923-16383"
}
]
}
],
"requestId": "e08f6e93-****-****-****-e222ab90f4fc",
"returnCode": "0",
"returnMessage": "success"
}
}
responseFormatType=xml
(기본값) 일 때
<?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisInstanceDetailResponse>
<requestId>e08f6e93-****-****-****-e222ab90f4fc</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudRedisInstanceList>
<cloudRedisInstance>
<cloudRedisInstanceNo>****511</cloudRedisInstanceNo>
<cloudRedisServiceName>test-****</cloudRedisServiceName>
<cloudRedisInstanceStatusName>running</cloudRedisInstanceStatusName>
<cloudRedisInstanceStatus>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Created State</codeName>
</cloudRedisInstanceStatus>
<cloudRedisInstanceOperation>
<code>NULL</code>
<codeName>CLOUD DATABASE(VPC) Null 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>
<isBackup>true</isBackup>
<backupTime>00:15</backupTime>
<backupFileRetentionPeriod>7</backupFileRetentionPeriod>
<backupSchedule>AUTO</backupSchedule>
<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>
<accessControlGroupNo>***50</accessControlGroupNo>
</accessControlGroupNoList>
<masterNodeCount>3</masterNodeCount>
<slaveNodeCount>3</slaveNodeCount>
<configGroupNo>***9</configGroupNo>
<configGroupName>test-***-config</configGroupName>
<cloudRedisServerInstanceList>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****613</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-001-001-ehs</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:03:43+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>0-5460</slotName>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****616</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-002-001-eht</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:04:10+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>5461-10922</slotName>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****619</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-003-001-ehu</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:04:06+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>10923-16383</slotName>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****622</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-001-002-ehv</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:03:43+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>0-5460</slotName>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****625</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-002-002-ehw</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:03:42+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>5461-10922</slotName>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****628</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-003-002-ehx</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null 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>
<uptime>2024-07-01T17:03:47+0900</uptime>
<createDate>2024-07-01T16:59:21+0900</createDate>
<slotName>10923-16383</slotName>
</cloudRedisServerInstance>
</cloudRedisServerInstanceList>
</cloudRedisInstance>
</cloudRedisInstanceList>
</getCloudRedisInstanceDetailResponse>
이 문서가 도움이 되었습니까?