跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/三层网络相关接口
POSTL3 Network Operations起始版本 0.6同步需要认证

创建三层网络

创建三层网络

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      三层网络的名称

    • descriptionString

      三层网络的详细描述

    • typeString

      三层网络类型

    • l2NetworkUuidString必填

      二层网络UUID

    • ipVersionString

      ip协议号

    • systemboolean

      是否用于系统云主机

    • dnsDomainString

      DNS域

    • resourceUuidString

      资源UUID。若指定，三层网络会使用该字段值作为UUID

    • categoryString

      网络类型，需要与system标签搭配使用，system为false时可设置为Public、Private

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

  • enableIPAMBoolean必填

    是否启用IP地址管理。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryL3NetworkInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • typeString必填

      三层网络类型

    • zoneUuidString必填

      区域UUID

    • l2NetworkUuidString必填

      二层网络UUID

    • stateString必填

      三层网络的可用状态

    • dnsDomainString必填

      DNS域

    • systemBoolean必填

      是否用于系统云主机

    • categoryString必填

      网络类型，需要与system标签搭配使用，system为false时可设置为Public、Private

    • ipVersionInteger必填

      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必填

      详情参考hostRoute

      • idLong必填

        资源ID。

      • l3NetworkUuidString必填

        三层网络UUID

      • prefixString必填

        暂无描述。

      • nexthopString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/l3-networks

/zstack/v1/l3-networks

操作 ID

CreateL3Network

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/l3-networks' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","type":"<type>","l2NetworkUuid":"<l2NetworkUuid>","ipVersion":"<ipVersion>","system":true,"dnsDomain":"<dnsDomain>","resourceUuid":"<resourceUuid>","category":"<category>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"],"enableIPAM":true}'

响应示例

200
{ "inventory": { "name": "Test-L3Network", "l2NetworkUuid": "1bfca1892b674df28d26d9a3c0f609f9", "category": "Private" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史