VPCリストの照会
    • PDF

    VPCリストの照会

    • PDF

    記事の要約

    VPC環境で利用できます。

    説明

    使用できるVPCリストを照会します。

    リクエスト

    リクエストURL

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

    リクエストヘッダ

    ヘッダ名説明
    x-ncp-apigw-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもので、
    API Gatewayサーバとの時間差が5分以上の場合、有効ではないリクエストとみなす
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyNAVERクラウドプラットフォームのポータルから発行された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-Typeリクエストボディーcontent typeをapplication/jsonに指定
    Content-Type: application/json

    リクエスト例

    GET https://vpcelasticsearch.apigw.ntruss.com/api/v1/cluster/getVpcList
    HOST: vpcelasticsearch.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
    
    curl -X GET "https://vpcelasticsearch.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=" 
    

    レスポンスパラメータ

    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;
    }
    

    フィールド

    パラメータ名タイプ説明
    contentArrayList<SubnetListDetailVo>VPCリスト
    createdDateDateTimeVo作成日時
    ipv4CidrStringVPC帯域
    regionNoStringNCPリージョンNo
    statusCodeStringVPCステータスコード
    vpcNameStringVPC名
    vpcNoIntegerVPC番号
    permissionStringSubaccountアカウントでの使用の可否です。Denyである場合、getVPCDetail権限がないため使用できない状態を意味します。
    formattedDateDate作成された日付
    formattedDateTimeDate作成された日付と時間
    utcLong作成されたUTC時間をミリ秒に変換

    レスポンス例

    {
      "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": "11",
            "statusCode": "RUN",
            "vpcName": "test",
            "vpcNo": 36752,
            "permission": "Allow"
          }
        ]
      },
      "requestId": "73cb1de6-c3e1-4a9d-9215-470158dd199f"
    }
    

    この記事は役に立ちましたか?

    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.