Deletes a data volume from a block gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteGatewayBlockVolumes

The operation that you want to perform. Set the value to DeleteGatewayBlockVolumes.

GatewayId String Yes gw-000eg44nmxbsfwb***

The ID of the bock gateway.

IndexId String Yes NFSalex-gx***

The index ID of the data volume. You can query the index ID by calling the DescribeGatewayBlockVolumes operation.

IsSourceDeletion Boolean No true

Specifies whether to delete data from the Object Storage Service (OSS) bucket. Valid values:

  • true: Data is deleted from the OSS bucket. Proceed with caution.
  • false: Data is not deleted from the OSS bucket.

    Default value: false

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. If the request is successful, 200 is returned.

Message String successsful

The description of the status code.

RequestId String 151BB31D-571D-4BB9-9A02-D4210E5BF5DB

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

TaskId String t-0000iwdggbhaordhk***

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteGatewayBlockVolumes
&GatewayId=gw-000eg44nmxbsfwb***
&IndexId=NFSalex-gx***
&<Common request parameters>

Sample success responses

XML format

<TaskId>t-0000iwdggbhaordhk***</TaskId>
<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>
<Message>successsful</Message>
<Code>200</Code>
<Success>true</Success>

JSON format

{
    "TaskId": "t-0000iwdggbhaordhk***",
    "RequestId": "151BB31D-571D-4BB9-9A02-D4210E5BF5DB",
    "Message": "successsful",
    "Code": 200,
    "Success": true
}

Error codes

HttpCode Error code Error message Description
400 EmptyGatewayId You must enter a valid ID for the gateway. The error message returned because the gateway ID is not specified.
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. The error message returned because the specified gateway does not exist. Check whether the parameters are valid.
400 GatewayInOperation The gateway is processing requests . Try again later. The error message returned because another operation is in progress. Try again later.
400 EmptyVolumeIndexId You must enter an index ID for the block volume. The error message returned because the index ID is not specified.

For a list of error codes, visit the API Error Center.