备案 控制台 登录 注册
文档中心 > DescribeVipForECS
DescribeVipForECS

最近更新时间：2021-12-24

请求方法：GET

接口描述： 调用DescribeVipForECS接口查询可用Vip列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

要执行的操作，取值：DescribeVipForECS。

RegionId

String

是

地域。

ParentInstanceId

String

是

主机的ID。


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

操作结果编码。

Msg

String

操作结果描述。

Res

Object[]

请求结果。

+InstanceId

String

VIP的ID。

+InstanceName

String

VIP的名称。

+UserId

String

用户ID。

+RegionId

String

地域ID。

+VpcId

String

VPC的ID。

+SubnetId

String

子网的ID。

+IpAddress

String

IP地址。

+BindEcs

Boolean

是否可以绑定云主机。

+CreateTime

Date

创建时间。

+Vpc

Object

VPC详情。

++InstanceId

String

VPC的ID。

++InstanceName

String

VPC的名称。

++Cidr

String

VPC的网段。

+Subnet

Object

子网详情。

++InstanceId

String

子网的ID。

++InstanceName

String

子网的名称。

++Cidr

String

子网的网段。

+Ecs

Object[]

主机详情。

++InstanceId

String

主机ID。

++InstanceName

String

主机名称。

++EniId

String

网卡ID。

++IpAddress

String

主机内网IP地址。


示例

请求示例

GET https://api.unicloud.com/networks/vip?Action=DescribeVipForECS

&RegionId=cb4c1d5f-7095-430a-8ea3-b5466b6093ea

&ParentInstanceId=ecs-j6ub1cq7uwvl

&<公共请求参数>

返回示例

JSON 格式

{
   "RequestId": "9afdf398-3265-4e05-a23c-4966a6182a00",
   "Msg": "查询可绑定ECS的虚IP成功",
   "Res": [
      {
           "InstanceId": "vip-kcyy9x9w8ycw",
           "CreateTime": "2020-11-10T13:41:42.000+0800",
           "Vpc": {
               "InstanceName": "vpc",
               "Cidr": "172.16.0.0/24",
               "InstanceId": "vpc-1o144h2si72ob"
          },
           "SubnetId": "ed889aef7370411da1c66a49b6c28424",
           "InstanceName": "aa",
           "Ecs": [
              {
                   "InstanceName": "i-jRv93jjVNC",
                   "EniId": "eni-kc14ffspqt9m",
                   "InstanceId": "ecs-kc14ffspqt9k",
                   "IpAddress": "172.16.0.29"
              }
          ],
           "VpcId": "vpc-1o144h2si72ob",
           "UserId": "484bb0bf-0fb3-47e5-a909-f14cc84f2ce3",
           "IpAddress": "172.16.0.25",
           "RegionId": "cn-tianjin-yfb",
           "Subnet": {
               "InstanceName": "ioo",
               "Cidr": "172.16.0.1/24",
               "InstanceId": "ed889aef7370411da1c66a49b6c28424"
          },
           "BindEcs": true
      }
  ],
   "Code": "Network.Success"
}