文档中心 > DescribeVip
DescribeVip

最近更新时间:2021-12-23

请求方法:GET

接口描述:调用DescribeVip接口获取Vip列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作,取值:DescribeVip。

RegionId

String

是

地域ID。

Page

Integer

否

当前页。

Size

Integer

否

页数大小。

InstanceId

String

否

VIP的ID。

InstanceName

String

否

VIP的名称。


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

操作结果编码。

Msg

String

操作结果描述。

Res

Object

请求结果。

+Page

Integer

当前页。

+Size

Integer

页数大小。

+Total

Long

总条数。

+Data

Object[]

响应数据。

++RegionId

String

区域ID。

++AzoneId

String

可用区ID。

++InstanceId

String

VIP的ID。

++InstanceName

String

VIP的名称。

++UserId

String

用户ID。

++SubnetId

String

子网ID。

++VpcId

String

VPC的ID。

++IpAddress

String

IP地址。

++BindEcs

boolean

是否可以绑定云主机。

++CreateTime

Date

创建时间。

++Vpc

Object

VPC详情。

+++InstanceName

String

VPC名称。

+++Cidr

Object

VPC网段。

+++InstanceId

Object

VPC ID。

++Subnet

Object

子网详情。

+++InstanceName

String

子网名称。

+++Cidr

String

子网网段。

+++InstanceId

String

子网ID。


示例

请求示例

GET https://api.unicloud.com/networks/vip?Action=DescribeVip
&RegionId=cn-beijing
&Page=1  
&Size=10  
&InstanceId=vip-j6ub1cq7uwvl  
&InstanceName=sdasads  
&<公共请求参数>

返回示例

JSON格式

{

    "RequestId": "9afdf398-3265-4e05-a23c-4966a6182a00",

    "Msg": "查询高可用虚拟IP成功",

    "Res": {

        "Size": 0,

        "Total": 2,

        "Data": [

            {

                "InstanceId": "vip-kfnimk0af1b4",

                "CreateTime": "2020-12-07T15:00:41.000+0800",

                "Vpc": {

                    "InstanceName": "dasd",

                    "Cidr": "10.0.0.0/24",

                    "InstanceId": "vpc-0in752py80cpb"

                },

                "SubnetId": "9e9f6ef74c994a1f94b74cbf34d4ca58",

                "InstanceName": "sad",

                "VpcId": "vpc-0in752py80cpb",

                "UserId": "8d877350-504d-414f-9e24-c4b1305cb5e7",

                "IpAddress": "10.0.0.11",

                "RegionId": "cn-beijing",

                "AzoneId": "cn-beijing-a",

                "Subnet": {

                    "InstanceName": "dasd",

                    "Cidr": "10.0.0.0/25",

                    "InstanceId": "9e9f6ef74c994a1f94b74cbf34d4ca58"

                },

                "BindEcs": true

            },

            {

                "InstanceId": "vip-keyvko68x2ev",

                "CreateTime": "2020-11-30T17:16:45.000+0800",

                "Vpc": {

                    "InstanceName": "dasd",

                    "Cidr": "10.0.0.0/24",

                    "InstanceId": "vpc-0in752py80cpb"

                },

                "SubnetId": "9e9f6ef74c994a1f94b74cbf34d4ca58",

                "InstanceName": "ddd",

                "VpcId": "vpc-0in752py80cpb",

                "UserId": "8d877350-504d-414f-9e24-c4b1305cb5e7",

                "IpAddress": "10.0.0.10",

                "RegionId": "cn-beijing",

                "AzoneId": "cn-beijing-a",

                "Subnet": {

                    "InstanceName": "dasd",

                    "Cidr": "10.0.0.0/25",

                    "InstanceId": "9e9f6ef74c994a1f94b74cbf34d4ca58"

                },

                "BindEcs": true

            }

        ],

        "Page": 0

    },

    "Code": "Network.Success"

 }