跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/VPC相关接口
PUTVPC Operations起始版本 3.9.0同步需要认证

更新虚拟路由器

更新虚拟路由器

调试可用性

在线调试

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

请求参数

请求体字段

  • updatevirtualrouterObject必填

    updatevirtualrouter 请求体结构

    • vmInstanceUuidString必填

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

    • defaultRouteL3NetworkUuidString

      暂无描述。

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVirtualRouterVmInventory必填

    详情参考inventory

    • publicNetworkUuidString必填

      暂无描述。

    • virtualRouterVipsList必填

      暂无描述。

    • applianceVmTypeString必填

      设备云主机类型。

    • managementNetworkUuidString必填

      暂无描述。

    • defaultRouteL3NetworkUuidString必填

      暂无描述。

    • statusString必填

      状态信息。

    • agentPortInteger必填

      代理端口。

    • haStatusString必填

      HA状态。

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      物理机UUID

    • lastHostUuidString必填

      最近一次主机UUID。

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      平台。

    • defaultL3NetworkUuidString必填

      暂无描述。

    • typeString必填

      类型。

    • hypervisorTypeString必填

      暂无描述。

    • memorySizeLong必填

      内存大小。

    • cpuNumInteger必填

      暂无描述。

    • cpuSpeedLong必填

      暂无描述。

    • allocatorStrategyString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

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

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        来源IP地址。

      • macString必填

        暂无描述。

      • hypervisorTypeString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • ipVersionInteger必填

        IP版本。

      • driverTypeString必填

        暂无描述。

      • deviceIdInteger必填

        设备ID。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • usedIpsList必填

        详情参考usedIps

        • uuidString必填

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

        • ipRangeUuidString必填

          IP段UUID

        • l3NetworkUuidString必填

          三层网络UUID

        • ipVersionInteger必填

          IP版本。

        • ipString必填

          来源IP地址。

        • netmaskString必填

          暂无描述。

        • gatewayString必填

          暂无描述。

        • usedForString必填

          已使用用于。

        • ipInLonglong必填

          暂无描述。

        • vmNicUuidString必填

          云主机网卡UUID

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

    • allVolumesList必填

      详情参考allVolumes

      • uuidString必填

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

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • primaryStorageUuidString必填

        主存储UUID

      • vmInstanceUuidString必填

        云主机UUID

      • diskOfferingUuidString必填

        云盘规格UUID

      • rootImageUuidString必填

        根镜像UUID。

      • installPathString必填

        安装路径。

      • typeString必填

        类型。

      • formatString必填

        数据格式或导出格式。

      • sizeLong必填

        返回记录数。

      • actualSizeLong必填

        实际大小。

      • deviceIdInteger必填

        设备ID。

      • stateString必填

        当前状态。

      • statusString必填

        状态信息。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否可分享。

      • volumeQosString必填

        暂无描述。

    • vmCdRomsList必填

      详情参考vmCdRoms

      • uuidString必填

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

      • vmInstanceUuidString必填

        云主机UUID

      • deviceIdInteger必填

        设备ID。

      • isoUuidString必填

        暂无描述。

      • isoInstallPathString必填

        iso安装路径。

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/vm-instances/appliances/virtual-routers/{vmInstanceUuid}/actions

/zstack/v1/vm-instances/appliances/virtual-routers/{vmInstanceUuid}/actions

操作 ID

UpdateVirtualRouter

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/vm-instances/appliances/virtual-routers/{vmInstanceUuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatevirtualrouter":{"vmInstanceUuid":"<vmInstanceUuid>","defaultRouteL3NetworkUuid":"<defaultRouteL3NetworkUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "publicNetworkUuid": "142981c8c8243113b52db453575fb03f", "managementNetworkUuid": "1d182cdfa0a93daa9e4eb275b86645ff", "name": "Test-Router", "description": "this is a virtual router vm", "clusterUuid": "ea4cb55d692a3c45a154892539117472", "imageUuid": "3764ffab842333c895a9e1746315fab3", "instanceOfferingUuid": "ba4019cd841430258d8943f281b36c19" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史