MENU
      VPC 목록 조회

        VPC 목록 조회


        기사 요약

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

        설명

        사용할 수 있는 VPC 목록을 조회합니다.

        요청

        요청 URL

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList [KR]
        GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getVpcList [SGN]
        GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getVpcList [JPN]
        HTTP

        요청 헤더

        헤더명설명
        x-ncp-apigw-timestamp- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄
        - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Access Key ID 값과 Secret Key로 암호화한 서명
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeRequest body content type을 application/json으로 지정
        Content-Type: application/json

        요청 예시

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList
        HOST: vpcsearchengine.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
        x-ncp-apigw-timestamp: 1593848345548
        x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
        HTTP
        curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getVpcList" \
        -H "accept: application/json" \
        -H "Content-Type: application/json" \
        -H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
        -H "x-ncp-apigw-timestamp: 1601971222179" \
        -H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="
        Bash

        응답 파라미터

        public class GetVpcListResponseVo {
            ArrayList<VpcListDetailVo> content;
        }
        
        public class VpcListDetailVo {
            DateTimeVo createdDate;
            String ipv4Cidr;
            String regionNo;
            String statusCode;
            String vpcName;
            Integer vpcNo;
            String permission;
        }
        
        public class DateTimeVo {
            @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul")
            Date formattedDate;
            @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss SSSSSS", timezone = "Asia/Seoul")
            Date formattedDateTime;
            Long utc;
        }
        Java

        필드

        파라미터명타입설명
        contentArrayList<SubnetListDetailVo>VPC 목록
        createdDateDateTimeVo생성 일자
        ipv4CidrStringVPC 대역
        regionNoStringNCP 리전 No
        statusCodeStringVPC 상태 코드
        vpcNameStringVPC 이름
        vpcNoIntegerVPC 번호
        permissionString- Subaccount 계정에서 사용 가능 여부
        - Deny일 경우 getVPCDetail 권한이 없어 사용이 불가능한 상태를 의미
        formattedDateDate생성된 날짜
        formattedDateTimeDate생성된 날짜 및 시간
        utcLong생성된 UTC 시간을 millisecond로 변환

        응답 예시

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "content": [
              {
                "createdDate": {
                  "formattedDate": "2020-06-22",
                  "formattedDateTime": "2020-06-22 10:18:24 000686",
                  "utc": 1592788704686
                },
                "ipv4Cidr": "10.0.0.0/20",
                "regionNo": "1",
                "statusCode": "RUN",
                "vpcName": "test",
                "vpcNo": 36752,
                "permission": "Allow"
              }
            ]
          },
          "requestId": "73cb1de6-c3e1-4a9d-9215-470158dd199f"
        }
        JSON

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

        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.