基本信息

Action

DescribeVxnets

Path

/iaas

Method

GET

请求参数

此接口除公共参数外,还包含以下参数。关于公共参数的更多信息,请参见前文内容

参数 参数类型 描述 是否必选

vxnets.n

String

私有网络ID

vxnet_type

Integer

私有网络类型,分为 1 - 受管私有网络,0 - 自管私有网络。

search_word

String

搜索关键词,支持私有网络ID,私有网络名称

tags.n

String

按照标签ID过滤, 只返回已绑定某标签的资源

verbose

Integer

是否返回冗长的信息,若为1,则返回已加入此私有网络的资源信息。

返回数据

此接口除了返回公共响应参数外,还返回以下参数。关于公共响应参数的更多信息,请参见前文内容

参数 参数类型 描述

vxnet_set

Array

JSON 格式的私有网络数据列表。

total_count

Integer

根据过滤条件得到的私有网络总数

vxnet_set 参数说明如下。

参数 参数类型 描述

vxnet_type

Integer

私有网络类型,分为 1 - 受管私有网络,0 - 自管私有网络。

vxnet_id

String

私有网络 ID

vxnet_name

String

私有网络名称

create_time

TimeStamp

创建时间,为UTC时间,格式可参见 ISO8601.

description

String

私有网络的描述

instance_ids

Array

已加入此私有网络的云服务器 ID 列表。只有在请求参数 verbose=1 才会返回此项。

router

Dict

与此私有网络相连的路由器信息,数据格式为:

"router":{
"router_id":"rtr-9iy0lt3s",
"router_name":"demo",
"manager_ip": "192.168.100.1",
"ip_network": "192.168.100.0/24",
"dyn_ip_end": "192.168.100.254",
"dyn_ip_start": "192.168.100.2",
"mode": 0
}

请求示例

https://api.<your_domain>/iaas/?action=DescribeVxnets
&vxnets.1=vxnet-ytuyg2q
&COMMON_PARAMS

返回示例

{
  "action":"DescribeVxnetsResponse",
  "total_count":2,
  "vxnet_set":[
    {
      "vxnet_type":1,
      "description":null,
      "vxnet_name":"test",
      "create_time":"2013-08-27T10:02:25Z",
      "router":{
        "router_id":"rtr-b0u6sdj6",
        "router_name":"demo",
        "manager_ip":"192.168.100.1",
        "ip_network":"192.168.100.0/24",
        "dyn_ip_end":"192.168.100.254",
        "dyn_ip_start":"192.168.100.2",
        "mode":0
      },
      "vxnet_id":"vxnet-ytuyg2q"
    }
  ],
  "ret_code":0
}