退订包周期计费模式的云硬盘
功能介绍
退订包周期计费模式的云硬盘,有如下约束:
-
系统盘、启动盘不可使用当前接口退订,必须和弹性云服务器一起退订
-
接口的请求body体最多可以传60个云硬盘id
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/cloudvolumes/unsubscribe
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释 项目ID。 获取方法请参见"获取项目ID"。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
volume_ids |
是 |
Array of strings |
参数解释 要退订的包周期云硬盘列表。 可通过EVS控制台的云硬盘列表页面获取云硬盘ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
响应参数
状态码:202
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of UnsubscribeVolumeResponseBody objects |
参数解释 退订包周期云硬盘的响应body体 取值范围 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
results |
Array of UnsubscribeVolume objects |
参数解释 退订包周期云硬盘的结果。 取值范围 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
volume_id |
String |
参数解释 卷id对应的结果 取值范围 不涉及。 |
order_id |
String |
参数解释 卷id对应的退订订单id,如果是已到期的云硬盘退订,则不显示此字段。 取值范围 不涉及。 |
result |
String |
参数解释 volume_id对应的退订结果。 取值范围 只有SUCCESS 和 FAIL两种结果。 |
fail_reason |
String |
参数解释 当result为FAIL时,此字段显示具体的失败原因。 result为SUCCESS时,不显示此字段。 取值范围 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of strings |
请求示例
退订包周期云硬盘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" } ] }
状态码:400
入参body体的云硬盘id有问题,需要检查
{ "error" : { "message" : "Volume id: [xxx, xxx]is not found in project: xxxx,please check.", "code" : "EVS.2203" } }
SDK代码示例
SDK代码示例如下。
退订包周期云硬盘8739ca48-1b86-46aa-9059-38623ee1346c和fc7d594d-e78f-49a8-ab6e-90ee6b560cb0
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; import java.util.List; import java.util.ArrayList; public class UnsubscribePostpaidVolumeSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("<YOUR REGION>")) .build(); UnsubscribePostpaidVolumeRequest request = new UnsubscribePostpaidVolumeRequest(); UnsubscribeVolumeRequestBody body = new UnsubscribeVolumeRequestBody(); List<String> listbodyVolumeIds = new ArrayList<>(); listbodyVolumeIds.add("fc7d594d-e78f-49a8-ab6e-90ee6b560cb0"); listbodyVolumeIds.add("8739ca48-1b86-46aa-9059-38623ee1346c"); body.withVolumeIds(listbodyVolumeIds); request.withBody(body); try { UnsubscribePostpaidVolumeResponse response = client.unsubscribePostpaidVolume(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
退订包周期云硬盘8739ca48-1b86-46aa-9059-38623ee1346c和fc7d594d-e78f-49a8-ab6e-90ee6b560cb0
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UnsubscribePostpaidVolumeRequest() listVolumeIdsbody = [ "fc7d594d-e78f-49a8-ab6e-90ee6b560cb0", "8739ca48-1b86-46aa-9059-38623ee1346c" ] request.body = UnsubscribeVolumeRequestBody( volume_ids=listVolumeIdsbody ) response = client.unsubscribe_postpaid_volume(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
退订包周期云硬盘8739ca48-1b86-46aa-9059-38623ee1346c和fc7d594d-e78f-49a8-ab6e-90ee6b560cb0
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := evs.NewEvsClient( evs.EvsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UnsubscribePostpaidVolumeRequest{} var listVolumeIdsbody = []string{ "fc7d594d-e78f-49a8-ab6e-90ee6b560cb0", "8739ca48-1b86-46aa-9059-38623ee1346c", } request.Body = &model.UnsubscribeVolumeRequestBody{ VolumeIds: listVolumeIdsbody, } response, err := client.UnsubscribePostpaidVolume(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
202 |
请求响应体 |
400 |
入参body体的云硬盘id有问题,需要检查 |
错误码
请参见错误码。