跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
PUTVM Related Interfaces起始版本 0.6同步需要认证

设置虚拟机SSH Key

设置虚拟机SSH Key

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • setvmsshkeyObject必填

    setvmsshkey 请求体结构

    • SshKeyString必填

      SSH键。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVmInstanceInventory必填

    详情参考inventory

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

        暂无描述。

      • hypervisorTypeString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • ipVersionInteger必填

        ip协议号

      • driverTypeString必填

        暂无描述。

      • internalNameString必填

        内部名称。

      • deviceIdInteger必填

        设备ID。

      • typeString必填

        类型。

      • stateString必填

        网卡状态

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

        暂无描述。

      • lastDetachDateTimestamp必填

        最近一次detach时间。

      • lastVmInstanceUuidString必填

        最近一次云主机实例UUID。

    • vmCdRomsList必填

      详情参考vmCdRoms

      • uuidString必填

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

      • vmInstanceUuidString必填

        虚拟机UUID

      • deviceIdInteger必填

        设备ID。

      • isoUuidString必填

        暂无描述。

      • isoInstallPathString必填

        iso安装路径。

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/vm-instances/{uuid}/actions

/zstack/v1/vm-instances/{uuid}/actions

操作 ID

SetVmSshKey

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "a9ac797c56ef3f3cbf507ae40aec4f27", "name": "Test-VM", "description": "web server VM", "zoneUuid": "2e70982580653273908fb2d9119c6f39", "clusterUuid": "d528e795695c3160bdf263e14fa1457b", "imageUuid": "e4682534b58436e1b485b9551d0feae7", "hostUuid": "a6d8de59ab5837adaef38c9f80609011", "lastHostUuid": "0fd913e716e83b029d22cff8eccd9ca0", "instanceOfferingUuid": "5509f4e5355e36629d7e8467a27bd67f", "rootVolumeUuid": "f7e96fc9d7413cd2b5aaf6099b66a8e1", "platform": "Linux", "defaultL3NetworkUuid": "016e9ab79d383faa941b37f9b3e7f2da", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8589934592, "cpuNum": 1, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Stopped", "vmNics": [ { "uuid": "2c2dffad4d8c3f51a693ac77c0ce61ce", "vmInstanceUuid": "a9ac797c56ef3f3cbf507ae40aec4f27", "usedIpUuid": "9e59064f42813027940517780bb7c4d9", "l3NetworkUuid": "016e9ab79d383faa941b37f9b3e7f2da", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "hypervisorType": "KVM", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0, "state": "enable", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "allVolumes": [ { "uuid": "f7e96fc9d7413cd2b5aaf6099b66a8e1", "name": "Root-Volume-For-VM-a9ac797c56ef3f3cbf507ae40aec4f27", "primaryStorageUuid": "0155f19398db3bfdafebfd3b5f2f70cf", "vmInstanceUuid": "a9ac797c56ef3f3cbf507ae40aec4f27", "diskOfferingUuid": "a6479afc6363359aa38a76235a2ff1d2", "rootImageUuid": "e4682534b58436e1b485b9551d0feae7", "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-f7e96fc9d7413cd2b5aaf6099b66a8e1/f7e96fc9d7413cd2b5aaf6099b66a8e1.qcow2", "type": "Root", "format": "qcow2", "size": 107374182400, "actualSize": 21474836480, "deviceId": 0, "state": "Enabled", "status": "Ready", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史