getCloudRedisInstanceList
    • PDF

    getCloudRedisInstanceList

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    Cloud DB for Redis 인스턴스 리스트를 조회합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    GET, POST/getCloudRedisInstanceList

    요청 헤더

    Cloud DB for Redis API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for Redis 요청 헤더를 참조해 주십시오.

    요청 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    regionCodeStringOptional조회할 Cloud DB for Redis 인스턴스의 리전 코드
    • getRegionList를 통해 확인
    • getRegionList 조회 결과의 첫 번째 리전(기본값)
    zoneCodeStringOptional존 코드로 필터링
    vpcNoStringOptionalVPC 번호로 필터링
    subnetNoStringOptionalSubnet 번호로 필터링
    cloudRedisServiceNameStringOptionalCloud DB for Redis 서비스 이름으로 필터링
    cloudRedisInstanceNoList.NList<String>OptionalCloud DB for Redis 인스턴스 번호 리스트
    • Cloud DB for Redis 인스턴스 번호로 필터링
    • getCloudRedisInstanceList를 통해 확인
    • <예시> cloudRedisInstanceNoList.1=1234&cloudRedisInstanceNoList.2=2345
    cloudRedisServerNameStringOptionalCloud DB for Redis 서버 이름으로 필터링
    cloudRedisServerInstanceNoList.NList<String>OptionalCloud DB for Redis 서버 인스턴스 번호 리스트
    • Cloud DB for Redis 서버 인스턴스 번호로 필터링
    • getCloudRedisInstanceList를 통해 확인
    • <예시> cloudRedisServerInstanceNoList.1=1234&cloudRedisServerInstanceNoList.2=2345
    generationCodeStringOptional서버 세대 코드로 필터링
    pageNoIntegerOptional페이징 처리된 결과의 페이지 번호
    • pageNo, pageSize를 이용하여 페이징 처리
    • 0 (최소)
    pageSizeIntegerConditional한 페이지에 보여줄 결과 개수
    • pageNo, pageSize를 이용하여 페이징 처리
    • pageNo 입력 시 필수
    • 1 (최소)
    responseFormatTypeStringOptional응답 결과의 형식
    • xml (기본값) | json

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisInstanceList
    ?regionCode=KR
    &zoneCode=KR-1
    &vpcNo=****83
    &subnetNo=****91
    &cloudRedisServiceName=test-****
    &cloudRedisInstanceNoList.1=****511
    &cloudRedisServerName=test-****
    &cloudRedisServerInstanceNoList.1=****613
    &generationCode=G2
    &pageNo=0
    &pageSize=10'
    --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 일 때
    {
        "getCloudRedisInstanceListResponse": {
            "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"
                    },
                    "isHa": true,
                    "generationCode": "G2",
                    "role": {
                        "code": "CLUSTER",
                        "codeName": "CLOUD REDIS(VPC) Cluster Role"
                    },
                    "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        },
                        {
                            "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"
                            },
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "cpuCount": 4,
                            "memorySize": 1610612736
                        }
                    ]
                }
            ],
            "requestId": "02c8adab-****-****-****-6d6b37885670",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • responseFormatType=xml (기본값) 일 때
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudRedisInstanceListResponse>
        <requestId>02c8adab-****-****-****-6d6b37885670</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>
                <isHa>true</isHa>
                <generationCode>G2</generationCode>
                <role>
                    <code>CLUSTER</code>
                    <codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
                </role>
                <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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </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>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****92</subnetNo>
                        <cpuCount>4</cpuCount>
                        <memorySize>1610612736</memorySize>
                    </cloudRedisServerInstance>
                </cloudRedisServerInstanceList>
            </cloudRedisInstance>
        </cloudRedisInstanceList>
    </getCloudRedisInstanceListResponse>
    

    이 문서가 도움이 되었습니까?

    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.