功能介紹
根據(jù)VPN網(wǎng)關(guān)ID，查詢指定的VPN網(wǎng)關(guān)
URI
GET /v5/{project_id}/vpn-gateways/{vgw_id}
|
名稱 |
類型 |
是否必選 |
說(shuō)明 |
|---|---|---|---|
|
project_id |
String |
是 |
項(xiàng)目ID，可以通過(guò)獲取項(xiàng)目ID獲取項(xiàng)目ID |
|
vgw_id |
String |
是 |
VPN網(wǎng)關(guān)ID |
- 請(qǐng)求樣例
GET https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}
響應(yīng)消息
- 響應(yīng)參數(shù)
表2 響應(yīng)Body參數(shù)列表 名稱
類型
描述
vpn_gateway
vpn_gateway對(duì)象
request_id
String
請(qǐng)求ID
表3 ResponseVpnGateway 名稱
類型
描述
id
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)ID
- 格式：36位UUID
name
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)名稱，不填時(shí)會(huì)自動(dòng)生成
- 取值范圍：1-64個(gè)字符，包括數(shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)。
network_type
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)網(wǎng)絡(luò)類型
- 取值范圍：public，private。
- 默認(rèn)值：public
status
String
attachment_type
String
- 功能說(shuō)明：關(guān)聯(lián)模式
- 取值范圍：vpc，er
er_id
String
VPN網(wǎng)關(guān)所連接的ER實(shí)例的ID。僅當(dāng)attachment_type為er時(shí)返回
vpc_id
String
當(dāng)attachment_type為vpc時(shí)，vpc_id是VPN網(wǎng)關(guān)關(guān)聯(lián)的業(yè)務(wù)VPC的ID。
當(dāng)attachment_type為er時(shí)，vpc_id是VPN網(wǎng)關(guān)的接入VPC的ID。
local_subnets
Array of String
本端子網(wǎng)。本端子網(wǎng)是云上子網(wǎng)，該網(wǎng)段需要通過(guò)VPN與用戶側(cè)網(wǎng)絡(luò)進(jìn)行互通。單個(gè)網(wǎng)段格式示例：192.168.52.0/24。僅當(dāng)attachment_type為vpc時(shí)返回。
connect_subnet
String
VPN網(wǎng)關(guān)所使用的VPC中的一個(gè)子網(wǎng)ID
bgp_asn
Long
VPN網(wǎng)關(guān)的BGP自治域編號(hào)
flavor
String
availability_zone_ids
Array of String
部署VPN網(wǎng)關(guān)的可用區(qū)。當(dāng)指定了可用區(qū)時(shí)則返回；當(dāng)未指定可用區(qū)時(shí)，在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時(shí)返回。
connection_number
Integer
VPN網(wǎng)關(guān)下的最大VPN連接數(shù)
used_connection_number
Integer
VPN網(wǎng)關(guān)下當(dāng)前已經(jīng)使用的VPN連接數(shù)
used_connection_group
Integer
VPN網(wǎng)關(guān)下當(dāng)前已經(jīng)使用的VPN連接組個(gè)數(shù)。同一用戶網(wǎng)關(guān)入云的兩條連接組成一個(gè)連接組。VPN網(wǎng)關(guān)默認(rèn)支持10個(gè)免費(fèi)的VPN連接組。
enterprise_project_id
String
master_eip
- 功能說(shuō)明：VPN網(wǎng)關(guān)使用的第一個(gè)EIP
- 約束：network_type為public時(shí)必選，為private時(shí)不需要填寫
說(shuō)明：
不推薦使用該字段，推薦使用eip1
eip1
雙活VPN網(wǎng)關(guān)表示使用的第一個(gè)EIP，主備模式VPN網(wǎng)關(guān)表示主EIP。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時(shí)返回。
slave_eip
否
- 功能說(shuō)明：VPN網(wǎng)關(guān)使用的第二個(gè)EIP
- 約束：network_type為public時(shí)必選，為private時(shí)不需要填寫
說(shuō)明：
不推薦使用該字段，推薦使用eip2
eip2
雙活VPN網(wǎng)關(guān)表示使用的第二個(gè)EIP，主備模式VPN網(wǎng)關(guān)表示備EIP。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時(shí)返回。
created_at
String
創(chuàng)建時(shí)間。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時(shí)返回。
updated_at
String
最后一次更新時(shí)間。在VPN網(wǎng)關(guān)的狀態(tài)為ACTIVE時(shí)返回。
access_vpc_id
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)使用的接入VPC ID
- 格式：36位UUID
access_subnet_id
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)使用的接入VPC中的子網(wǎng)ID
- 格式：36位UUID
access_private_ips
Array of String
私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP列表，VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對(duì)端網(wǎng)關(guān)建連。固定返回兩個(gè) ip地址 。
示例：192.168.52.9。僅當(dāng)network_type為private時(shí)返回。
說(shuō)明：不推薦使用，推薦使用access_private_ip_1和access_private_ip_2
access_private_ip_1
String
私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP，VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對(duì)端網(wǎng)關(guān)建連。雙活網(wǎng)關(guān)表示使用的第一個(gè)私網(wǎng)地址，主備表示主私網(wǎng)地址。
示例：192.168.52.9。僅當(dāng)network_type為private時(shí)返回。
access_private_ip_2
String
私網(wǎng)類型VPN網(wǎng)關(guān)的接入私網(wǎng)IP，VPN網(wǎng)關(guān)使用該私網(wǎng)IP與對(duì)端網(wǎng)關(guān)建連。雙活網(wǎng)關(guān)表示使用的第二個(gè)私網(wǎng)地址，主備表示備私網(wǎng)地址。
示例：192.168.52.9。僅當(dāng)network_type為private時(shí)返回。
certificate_id
String
- 功能說(shuō)明：VPN網(wǎng)關(guān)使用的VPN網(wǎng)關(guān)證書(shū)ID，僅在flavor為GM時(shí)返回。
- 格式：36位UUID
ha_mode
String
- 功能說(shuō)明：網(wǎng)關(guān)的HA模式，"active-active"表示雙活，"active-standby"表示主備
- 取值范圍：active-active，active-standby
- 默認(rèn)值：active-active
表4 ResponseEip 名稱
類型
描述
id
String
- 功能說(shuō)明：EIP的ID
- 格式：36位UUID。當(dāng)使用默認(rèn)企業(yè)項(xiàng)目時(shí)返回"0"
ip_version
Integer
- 功能說(shuō)明：EIP版本
- 取值范圍：4
ip_billing_info
String
type
String
- 功能說(shuō)明：EIP的類型
- 取值范圍：可查看申請(qǐng)EIP表6中type字段的取值范圍。
ip_address
String
- 功能說(shuō)明：EIP的 公網(wǎng)IP v4地址
- 格式：ipv4類型地址。例如：88.***.***.11。
charge_mode
String
bandwidth_id
String
- 功能說(shuō)明：EIP的帶寬ID
- 格式：36位UUID
bandwidth_size
Integer
- 功能說(shuō)明：EIP的帶寬大小，單位：Mbit/s。每個(gè)region能夠提供的EIP最大帶寬不同，EIP的最大帶寬受限于EIP服務(wù)，可以使用工單來(lái)提高賬戶下的EIP的最大帶寬。
- 取值范圍：1-1000
bandwidth_name
String
- 功能說(shuō)明：EIP的帶寬名稱
- 取值范圍：1-64個(gè)字符，支持?jǐn)?shù)字、英文字母、中文(\u4e00 - \u9fa5)、_(下劃線)、-(中劃線)、.(點(diǎn))。
bandwidth_billing_info
String
- 公網(wǎng)類型關(guān)聯(lián)ER的VPN網(wǎng)關(guān)的響應(yīng)樣例
{ "vpn_gateway": { "id": "66ddeacb-****-****-****-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "public", "status": "ACTIVE", "attachment_type": "er", "er_id": "c62fad0d-****-****-****-e06c4c351b9f", "bgp_asn": 64512, "flavor": "Professional1", "availability_zone_ids": ["cn-south-1f", "cn-south-1e"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "eip1": { "id": "0f6d1415-****-****-****-edb2ee97c9cc", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.251", "charge_mode": "bandwidth", "bandwidth_id": "e93767cc-****-****-****-bac2987f90a4", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-10c3" }, "eip2": { "id": "7b46b62f-****-****-****-6b8e44312416", "ip_version": 4, "type": "5_bgp", "ip_address": "88.***.***.102", "charge_mode": "bandwidth", "bandwidth_id": "bde3557e-****-****-****-629a3754ae07", "bandwidth_size": 300, "bandwidth_name": "vpngw-bandwidth-18bd" }, "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa", "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" } - 私網(wǎng)類型關(guān)聯(lián)VPC的VPN網(wǎng)關(guān)的響應(yīng)樣例
{ "vpn_gateway": { "id": "66ddeacb-****-****-****-9a414b5bd7d5", "name": "vpngw-5bd6", "network_type": "private", "status": "ACTIVE", "attachment_type": "vpc", "vpc_id": "91a74241-****-****-****-9b5f98c66c8c", "local_subnets": ["192.168.0.0/24"], "connect_subnet": "f5741286-****-****-****-2c82bd9ee114", "bgp_asn": 64512, "flavor": "Professional1", "availability_zone_ids": ["cn-south-1f", "cn-south-1e"], "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "created_at": "2022-11-28T02:22:27.24Z", "updated_at": "2022-11-28T02:22:27.24Z", "access_vpc_id": "0cf79a3f-****-****-****-d7ace626b0fa", "access_subnet_id": "f5741286-****-****-****-2c82bd9ee114", "access_private_ip_1": "192.168.146.45", "access_private_ip_2": "192.168.146.77", "ha_mode": "active-active" }, "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" }
狀態(tài)碼
請(qǐng)參見(jiàn)狀態(tài)碼
