VPCリストの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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]

リクエストヘッダ

ヘッダ名	説明
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	NAVERクラウドプラットフォームのポータルから発行されたAccess Key ID値 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値とSecret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	リクエストボディー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

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="

レスポンスパラメータ

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

フィールド

パラメータ名	タイプ	説明
content	ArrayList<SubnetListDetailVo>	VPCリスト
createdDate	DateTimeVo	作成日時
ipv4Cidr	String	VPC帯域
regionNo	String	NCPリージョンNo
statusCode	String	VPCステータスコード
vpcName	String	VPC名
vpcNo	Integer	VPC番号
permission	String	Subaccountアカウントでの使用の可否です。Denyである場合、getVPCDetail権限がないため使用できない状態を意味します。
formattedDate	Date	作成された日付
formattedDateTime	Date	作成された日付と時間
utc	Long	作成された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": "1",
        "statusCode": "RUN",
        "vpcName": "test",
        "vpcNo": 36752,
        "permission": "Allow"
      }
    ]
  },
  "requestId": "73cb1de6-c3e1-4a9d-9215-470158dd199f"
}

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

What's Next

Subnetリストの照会

説明
リクエスト
レスポンスパラメータ
フィールド

タグ

Search Engine Service