跳转到主要内容
API Explorer|API Explorer
计算管理/镜像存储相关接口/镜像存储相关接口/本地镜像仓库相关接口
PUTStandalone Image Storage Related Interfaces起始版本 1.6同步需要认证

更新本地镜像仓库信息

更新本地镜像仓库信息

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

    镜像仓库的UUID

请求体字段

  • updateimagestorebackupstorageObject必填

    updateimagestorebackupstorage 请求体结构

    • usernameString

      SSH 用户名 (用于 Ansible 部署)

    • passwordString

      SSH 用户密码

    • hostnameString

      镜像仓库主机名

    • sshPortInteger

      SSH 端口号

    • nameString

      镜像仓库的新名称

    • descriptionString

      镜像仓库的更新详细描述

    • systemTagsList

      系统标签

    • userTagsList

      用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryBackupStorageInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • urlString必填

      地址。

    • descriptionString必填

      资源的详细描述

    • totalCapacityLong必填

      总容量。

    • availableCapacityLong必填

      可用容量。

    • typeString必填

      类型。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • attachedZoneUuidsList必填

      附加区域UUID。

请求地址

PUT/zstack/v1/backup-storage/image-store/{uuid}/actions

/zstack/v1/backup-storage/image-store/{uuid}/actions

操作 ID

UpdateImageStoreBackupStorage

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/backup-storage/image-store/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updateimagestorebackupstorage":{"username":"<username>","password":"<password>","hostname":"<hostname>","sshPort":1,"name":"<name>","description":"<description>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}}'

响应示例

200
{ "inventory": { "name": "New Name", "description": "Public Backup Storage", "totalCapacity": 1.073741824E9, "availableCapacity": 9.68884224E8, "type": "Ceph", "state": "Enabled", "status": "Connected", "createDate": "Jun 7, 2017 9:20:12 PM", "lastOpDate": "Jun 7, 2017 9:20:12 PM", "attachedZoneUuids": [ "7c99892d8d5542faae4d1dd7d17be252" ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史