跳转到主要内容
计算管理/虚拟机相关接口
GETVM Related Interfaces起始版本 4.1.0同步需要认证

获取虚拟机网卡可挂载的分布式端口组

获取虚拟机网卡可挂载的分布式端口组

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

查询参数

请求参数

路径参数

  • vmNicUuidString必填

    虚拟机网卡UUID

查询参数

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段,默认为null

    • opaqueLinkedHashMap必填

      保留字段,默认为null

    • causeErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • inventoryList必填

    详情参考inventory

    • uuidString必填

      资源的UUID,唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      类型。

    • zoneUuidString必填

      数据中心UUID

    • l2NetworkUuidString必填

      端口组分布式交换机UUID

    • stateString必填

      当前状态。

    • dnsDomainString必填

      DNS域。

    • systemBoolean必填

      系统。

    • categoryString必填

      类型分类。

    • ipVersionInteger必填

      IP协议号

    • enableIPAMBoolean必填

      打开IP地址管理功能

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • dnsList必填

      暂无描述。

    • ipRangesList必填

      详情参考ipRanges

      • uuidString必填

        资源的UUID,唯一标示该资源

      • l3NetworkUuidString必填

        分布式端口组UUID

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • startIpString必填

        起始地址

      • endIpString必填

        结束地址

      • netmaskString必填

        掩码

      • prefixLenString必填

        掩码长度

      • gatewayString必填

        网关

      • networkCidrString必填

        网络CIDR

      • ipVersionInteger必填

        ip协议号

      • addressModeString必填

        IPv6地址分配模式

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • ipRangeTypeIpRangeType必填

        详情参考ipRangeType

        • NormalIpRangeType必填

          普通地址段

        • AddressPoolIpRangeType必填

          地址池段

    • networkServicesList必填

      详情参考networkServices

      • l3NetworkUuidString必填

        分布式端口组UUID

      • networkServiceProviderUuidString必填

        网络服务提供模块UUID

      • networkServiceTypeString必填

        暂无描述。

    • hostRouteList必填

      详情参考ipRangesx

      • idLong必填

        资源ID。

      • l3NetworkUuidString必填

        分布式端口组UUID

      • prefixString必填

        暂无描述。

      • nexthopString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • reservedIpRangesList必填

      详情参考reservedIpRanges

      • uuidString必填

        资源的UUID,唯一标示该资源

      • l3NetworkUuidString必填

        分布式端口组UUID

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • startIpString必填

        起始IP(包含在保留地址段内)

      • endIpString必填

        结束IP(包含在保留地址段内)

      • ipVersionInteger必填

        ip协议号

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/vm-instances/nics/{vmNicUuid}/l3-networks-candidates

/zstack/v1/vm-instances/nics/{vmNicUuid}/l3-networks-candidates

操作 ID

GetCandidateL3NetworksForChangeVmNicNetwork

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/nics/{vmNicUuid}/l3-networks-candidates?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "f8fc36eaff6f3253a134bab93823baf1", "name": "private L3", "type": "L3BasicNetwork", "zoneUuid": "9ef7d386414c3101adeecd45ec9a2d51", "l2NetworkUuid": "ad3adf2da22f36c2946d90fae7f99b19", "state": "Enabled", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "ipRanges": [ { "uuid": "16f163ee55f93d4f8dca9fefcac41ecc", "l3NetworkUuid": "f8fc36eaff6f3253a134bab93823baf1", "name": "ip range", "startIp": "192.168.0.10", "endIp": "192.168.0.100", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "networkServices": [ { "l3NetworkUuid": "f8fc36eaff6f3253a134bab93823baf1", "networkServiceProviderUuid": "f714dba2f49a3d6788aafbe8b5ab3dc2", "networkServiceType": "DHCP" }, { "l3NetworkUuid": "f8fc36eaff6f3253a134bab93823baf1", "networkServiceProviderUuid": "f714dba2f49a3d6788aafbe8b5ab3dc2", "networkServiceType": "DNS" }, { "l3NetworkUuid": "f8fc36eaff6f3253a134bab93823baf1", "networkServiceProviderUuid": "f714dba2f49a3d6788aafbe8b5ab3dc2", "networkServiceType": "SNAT" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史