跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云主机相关接口
GETVM Instance Operations起始版本 0.6同步需要认证

获取云主机可加载L3网络列表

获取云主机可加载L3网络列表

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • vmInstanceUuidString必填

    云主机UUID

查询参数

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      类型。

    • zoneUuidString必填

      区域UUID

    • l2NetworkUuidString必填

      二层网络UUID

    • stateString必填

      当前状态。

    • dnsDomainString必填

      DNS域。

    • systemBoolean必填

      系统。

    • categoryString必填

      类型分类。

    • ipVersionInteger必填

      IP协议号

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • dnsList必填

      暂无描述。

    • ipRangesList必填

      详情参考ipRanges

      • uuidString必填

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

      • l3NetworkUuidString必填

        三层网络UUID

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • startIpString必填

        开始IP。

      • endIpString必填

        结束IP。

      • netmaskString必填

        暂无描述。

      • prefixLenString必填

        掩码长度

      • gatewayString必填

        暂无描述。

      • networkCidrString必填

        暂无描述。

      • ipVersionInteger必填

        IP协议号

      • addressModeString必填

        IPv6地址分配模式

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • networkServicesList必填

      详情参考networkServices

      • l3NetworkUuidString必填

        三层网络UUID

      • networkServiceProviderUuidString必填

        网络服务提供模块UUID

      • networkServiceTypeString必填

        暂无描述。

    • hostRouteList必填

      详情参考hostRoute

      • idLong必填

        资源ID。

      • l3NetworkUuidString必填

        三层网络UUID

      • prefixString必填

        暂无描述。

      • nexthopString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

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

/zstack/v1/vm-instances/{vmInstanceUuid}/l3-networks-candidates

操作 ID

GetVmAttachableL3Network

永久链接

请求示例

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

响应示例

200
{ "inventories": [ { "uuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "name": "private L3", "type": "L3BasicNetwork", "zoneUuid": "67a6601dc8dd476ebca371123ff03f14", "l2NetworkUuid": "94bdffb080b346e7a3ac2f44f574cc4a", "state": "Enabled", "createDate": "Apr 24, 2017 7:11:08 PM", "lastOpDate": "Apr 24, 2017 7:11:08 PM", "ipRanges": [ { "uuid": "e15972969ac64d1ea01c0c228d969bcc", "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "name": "ip range", "startIp": "192.168.0.10", "endIp": "192.168.0.100", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "createDate": "Apr 24, 2017 7:11:08 PM", "lastOpDate": "Apr 24, 2017 7:11:08 PM" } ], "networkServices": [ { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "DHCP" }, { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "DNS" }, { "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b", "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182", "networkServiceType": "SNAT" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史