MENU
      Search VPC list

        Search VPC list


        Article summary

        Can be used in a VPC environment.

        Description

        Search a list of available VPCs.

        Request

        Request URL

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

        Request headers

        HeaderDescription
        x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
        If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyThis is the Access Key ID value issued by the Naver Cloud Platform.
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2This is the signature encrypted Access Key ID value and Secret Key.
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecifies the request body content type as application/json
        Content-Type: application/json

        Request example

        GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getVpcList
        HOST: clouddatastreamingservice.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://clouddatastreamingservice.apigw.ntruss.com/api/v1/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

        Response parameters

        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 {
            Date formattedDate;
            Date formattedDateTime;
            Long utc;
        }
        Java

        Field

        Parameter nameTypeDescription
        contentArrayListList of VPCs
        createdDateDateTimeVoCreated date
        ipv4CidrStringVPC range
        regionNoStringNCP region number
        statusCodeStringVPC status code
        vpcNameStringVPC name
        vpcNoIntegerVPC number
        permissionStringThis is the availability status of a Subaccount's account. If it's set to Deny, it means that it is not available since you have no getVPCDetail permissions.
        formattedDateDateCreation date
        formattedDateTimeDateCreation date and time
        utcLongConvert the UTC time created into milliseconds

        Response example

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "error": null,
            "content": [
              {
                "createdDate": {
                  "formattedDate": "2020-09-17",
                  "formattedDateTime": "2020-09-17 10:31:50 000850",
                  "utc": 1600306310850
                },
                "ipv4Cidr": "10.0.0.0/16",
                "regionNo": "1",
                "statusCode": "RUN",
                "vpcName": "clean",
                "vpcNo": 1236,
                "actionName": "View/getVPCDetail",
                "permission": "Allow"
              }
            ]
          },
          "requestId": "83cba231-146e-42dc-9196-0b9d9e4cdda5"
        }
        JSON

        Was this article helpful?

        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.