跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云盘相关接口
GETVolume Operations起始版本 0.6同步需要认证

获取云盘限速

获取云盘限速

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • uuidString必填

    云盘的UUID

查询参数

  • systemTagsList

    可选。

  • userTagsList

    可选。

请求体字段

  • forceSyncBoolean

    是否到物理机上去同步数据

响应状态

200 OK

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

  • volumeUuidString必填

    云盘UUID

  • volumeBandwidthlong必填

    云盘带宽，默认-1

  • volumeBandwidthReadlong必填

    云盘读带宽，默认-1

  • volumeBandwidthWritelong必填

    云盘写带宽，默认-1

  • volumeBandwidthUpthresholdlong必填

    云盘带宽上限，默认-1

  • volumeBandwidthReadUpthresholdlong必填

    云盘读带宽上限，默认-1

  • volumeBandwidthWriteUpthresholdlong必填

    云盘写带宽上限，默认-1

  • iopsTotalUpthresholdlong必填

    云盘总IOPS上限，-1表示无上限限制

  • iopsReadUpthresholdlong必填

    云盘读取IOPS上限，-1表示无上限限制

  • iopsWriteUpthresholdlong必填

    云盘写入IOPS上限，-1表示无上限限制

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/volumes/{uuid}/qos

/zstack/v1/volumes/{uuid}/qos

操作 ID

GetVolumeQoS

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/volumes/{uuid}/qos?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"forceSync":true}'

响应示例

200
{ "volumeUuid": "1dc9ff4cedae33eb84651468db5734ae", "volumeBandwidth": 100000.0, "volumeBandwidthRead": -1.0, "volumeBandwidthWrite": -1.0, "iopsTotal": -1.0, "iopsRead": 10000.0, "iopsWrite": 10000.0, "volumeBandwidthUpthreshold": 200000.0, "volumeBandwidthReadUpthreshold": -1.0, "volumeBandwidthWriteUpthreshold": -1.0, "iopsTotalUpthreshold": -1.0, "iopsReadUpthreshold": 20000.0, "iopsWriteUpthreshold": 15000.0 }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史