获取VPN网关信息-DescribeVPNGateway

获取VPN网关信息

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口Yes
VPNGatewayIds.nstringVPN网关的资源ID,例如VPNGatewayIds.0代表希望获取VPN网关1的信息,VPNGatewayIds.1代表VPN网关2,如果为空,则返回当前Region中所有VPN网关的信息No
VPCIdstringVPC的资源ID,返回指定的VPC下的所有VPN网关的信息。默认返回当前Region中所有VPN网关实例的信息No
Offsetint数据偏移量。默认为0No
Tagstring业务组名称,若指定则返回指定的业务组下的所有VPN网关的信息。No
Limitint数据分页值。默认为20No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
TotalCountint满足条件的VPN网关总数No
DataSetarray获取的VPN网关信息列表,每项参数详见 VPNGatewayDataSetNo

Request Example

https://api.ucloud.cn/?Action=DescribeVPNGateway
&Region=cn-sh2
&ProjecId=org-XXXX
&VPNGatewayId.0=vpngw-XXXX
&VPNGatewayId.1=vpngw-XXXX
&VPCId=uvnet-XXXX
&Offset=2
&Limit=3
&Tag=Default

Response Example

{
    "Action": "DescribeVPNGatewayResponse",
    "TotalCount": 1,
    "RetCode": 0,
    "DataSet": [
        {
            "EIP": "106.75.XX.78",
            "Remark": "",
            "VPCId": "uvnet-XX",
            "Grade": "Standard",
            "VPCName": "",
            "EIPId": "eip-XX",
            "ExpireTime": 1530374400,
            "AutoRenew": "Yes",
            "Tag": "Default",
            "EIPType": "Bgp",
            "ChargeType": "Month",
            "VPNGatewayName": "111111",
            "CreateTime": 1530070980,
            "VPNGatewayId": "vpngw-XXX"
        }
    ]
}
如有疑问请联系 技术支持