跳转到主要内容
API Explorer|API Explorer
资源中心/VMware管理(Plus)/vCenter相关接口
POSTvCenter Operations起始版本 0.6同步需要认证

添加vCenter资源

添加vCenter资源

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • usernameString必填

      登录 vCenter 用户名

    • passwordString必填

      登录 vCenter 用户密码

    • zoneUuidString必填

      vCenter 将要添加至的目标区域UUID

    • nameString必填

      vCenter 的名称

    • httpsboolean

      是否启用 HTTPS 登录（默认开启）

    • domainNameString必填

      vCenter 域名

    • descriptionString

      vCenter 的详细描述

    • resourceUuidString

      vCenter 的UUID。若指定，云主机会使用该字段值作为UUID。

    • portInteger

      可选。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVCenterInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • domainNameString必填

      域名称。

    • portInteger必填

      端口号。

    • userNameString必填

      用户名称。

    • zoneUuidString必填

      区域UUID

    • httpsBoolean必填

      暂无描述。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

  • skippedResourcesSkippedResources必填

    详情参考skippedResources

    • vmInstancesSet必填

      详情参考vmInstances

      • uuidString必填

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

      • nameString必填

        资源名称

      • descriptionString

        资源的详细描述

      • zoneUuidString必填

        区域UUID

      • clusterUuidString必填

        集群UUID

      • imageUuidString必填

        镜像UUID

      • hostUuidString必填

        物理机UUID

      • lastHostUuidString必填

        最近一次主机UUID。

      • instanceOfferingUuidString必填

        计算规格UUID

      • rootVolumeUuidString必填

        根云盘UUID

      • platformString必填

        平台。

      • architectureString必填

        架构类型

      • defaultL3NetworkUuidString必填

        暂无描述。

      • typeString必填

        类型。

      • hypervisorTypeString必填

        暂无描述。

      • memorySizeLong必填

        内存大小。

      • cpuNumInteger必填

        暂无描述。

      • cpuSpeedLong必填

        暂无描述。

      • allocatorStrategyString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • stateString必填

        当前状态。

      • guestOsTypeString必填

        操作系统类型

      • vmNicsList必填

        详情参考vmNics

        • uuidString必填

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

        • vmInstanceUuidString必填

          云主机UUID

        • l3NetworkUuidString必填

          三层网络UUID

        • ipString必填

          IP地址

        • macString必填

          MAC地址

        • hypervisorTypeString必填

          虚拟化类型

        • netmaskString必填

          子网掩码

        • gatewayString必填

          网关

        • metaDataString必填

          元数据。

        • ipVersionInteger必填

          IP地址版本

        • deviceIdInteger必填

          设备ID

        • typeString必填

          网卡类型

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

          云盘QoS，格式如total=1048576

      • vmCdRomsList必填

        详情参考vmCdRoms

        • uuidString必填

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

        • vmInstanceUuidString必填

          云主机UUID

        • deviceIdInteger必填

          光驱顺序号

        • isoUuidString必填

          ISO镜像UUID

        • isoInstallPathString必填

          ISO镜像挂载路径

        • nameString必填

          资源名称

        • descriptionString

          资源的详细描述

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

请求地址

POST/zstack/v1/vcenters

/zstack/v1/vcenters

操作 ID

AddVCenter

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/vcenters' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"username":"<username>","password":"<password>","zoneUuid":"<zoneUuid>","name":"<name>","https":true,"domainName":"<domainName>","description":"<description>","resourceUuid":"<resourceUuid>","port":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "1497ae9206ea3f82bb13c34c307299b9", "name": "vc1", "domainName": "vsphere-local.net", "userName": "admin@vsphere-local.net", "https": true, "state": "Enabled", "status": "Connected" }, "skippedResources": { "vmInstances": [ { "uuid": "example", "name": "exampleVm" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史