文档首页> 云硬盘 EVS> API参考> API> 云硬盘管理> 退订包周期计费模式的云硬盘
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

退订包周期计费模式的云硬盘

功能介绍

退订包周期计费模式的云硬盘，有如下约束：

  • 系统盘、启动盘不可使用当前接口退订，必须和弹性云服务器一起退订
  • 接口的请求body体最多可以传60个云硬盘id

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/cloudvolumes/unsubscribe

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。 获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

volume_ids

是

Array of strings

退订包周期云硬盘的结果。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of UnsubscribeVolumeResponseBody objects

请求响应体
表5 UnsubscribeVolumeResponseBody

参数

参数类型

描述

results

Array of UnsubscribeVolume objects

退订包周期云硬盘的结果。
表6 UnsubscribeVolume

参数

参数类型

描述

volume_id

String

卷id对应的结果

order_id

String

卷id对应的退订订单id，如果是已到期的云硬盘退订，则不显示此字段。

result

String

volume_id对应的退订结果，只有SUCCESS 和 FAIL两种结果。

fail_reason

String

当result为FAIL时，此字段显示具体的失败原因。 result为SUCCESS时，不显示此字段。

请求示例

退订包周期云硬盘8739ca48-1b86-46aa-9059-38623ee1346c和fc7d594d-e78f-49a8-ab6e-90ee6b560cb0

POST /v2/{project_id}/cloudvolumes/unsubscribe

{
  "volume_ids" : [ "fc7d594d-e78f-49a8-ab6e-90ee6b560cb0", "8739ca48-1b86-46aa-9059-38623ee1346c" ]
}

响应示例

状态码： 202

请求响应体

{
  "results" : [ {
    "volume_id" : "8739ca48-1b86-46aa-9059-38623ee1346c",
    "order_id" : "CS23021116385NAOR",
    "result" : "SUCCESS"
  }, {
    "volume_id" : "fc7d594d-e78f-49a8-ab6e-90ee6b560cb0",
    "result" : "FAIL",
    "fail_reason" : "INTERNAL ERROR, please contact customer service"
  } ]
}

状态码

状态码

描述

202

请求响应体

错误码

请参见错误码。

父主题： 云硬盘管理