跳转到主要内容
API Explorer|API Explorer
网络管理/网络资源/分布式端口组相关接口
PUTDistributed Port Group Related Interfaces起始版本 0.6同步需要认证

改变分布式端口组状态

改变分布式端口组状态

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • changel3networkstateObject必填

    changel3networkstate 请求体结构

    • stateEventString

      状态，可选enable与disable

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

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

      类型分类。

    • ipVersionInteger必填

      ip协议号

    • enableIPAMBoolean必填

      打开IP地址管理功能

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • dnsList必填

      暂无描述。

    • ipRangesList必填

      详情参考ipRanges

    • networkServicesList必填

      详情参考networkServices

      • l3NetworkUuidString必填

        分布式端口组UUID

      • networkServiceProviderUuidString必填

        网络服务提供模块UUID

      • networkServiceTypeString必填

        暂无描述。

    • hostRouteList必填

      详情参考hostRoute

      • idLong必填

        资源ID。

      • l3NetworkUuidString必填

        分布式端口组UUID

      • prefixString必填

        暂无描述。

      • nexthopString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • reservedIpRangesList必填

      详情参考reservedIpRanges

      • uuidString必填

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

      • l3NetworkUuidString必填

        分布式端口组UUID

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • startIpString必填

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

      • endIpString必填

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

      • ipVersionInteger必填

        ip协议号

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/l3-networks/{uuid}/actions

/zstack/v1/l3-networks/{uuid}/actions

操作 ID

ChangeL3NetworkState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/l3-networks/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changel3networkstate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "name": "Test-L3Network", "l2NetworkUuid": "dfae4bce43694f4d9fc0ba5cdf4e38bd" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史