获取客户VPN网关信息-DescribeRemoteVPNGateway

获取客户VPN网关信息

Request Parameters

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

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
TotalCountint符合条件的客户VPN网关总数No
DataSetarray客户VPN网关列表, 每项参数详见 RemoteVPNGatewayDataSetNo

RemoteVPNGatewayDataSet

Parameter nameTypeDescriptionRequired
RemoteVPNGatewayIdstring客户网关IDNo
RemoteVPNGatewayNamestring客户网关名称No
RemoteVPNGatewayAddrstring客户网关IP地址No
Tagstring用户组No
Remarkstring备注No
CreateTimeint创建时间No
ActiveTunnelsstring活跃的隧道idNo
TunnelCountint活跃的隧道数量No

Request Example

https://api.ucloud.cn/?Action=DescribeRemoteVPNGateway
&Region=cn-sh2
&ProjecId=org-XXXX
&RemoteVPNGatewayId= remotevpngw-XXXXX
&Tag=Default
&Offset=1
&Limit=7

Response Example

{
    "Action": "DescribeRemoteVPNGatewayResponse",
    "DataSet": [
        {
            "ActiveTunnels": [
                "vpntunnel-XXXX"
            ],
            "CreateTime": 1530070801,
            "Remark": "test",
            "RemoteVPNGatewayAddr": "1.1.XX.1",
            "RemoteVPNGatewayId": "remotevpngw-XXX",
            "RemoteVPNGatewayName": "test",
            "Tag": "Default",
            "TunnelCount": 1
        }
    ],
    "RetCode": 0,
    "TotalCount": 1
}
如有疑问请联系 技术支持