Delete a Cache Disk from a File Gateway - Cloud Storage Gateway

Operation description

Before you call this operation, note the following:

This operation is valid only for online gateways.
You can delete only pay-as-you-go cache disks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DeleteGatewayCacheDisk

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-0001xv7je3580031y***
CacheId	string	Yes	The ID of the cache disk. You can call the DescribeGatewayCaches operation to query the ID of the cache disk.	d-bp1dcnq8zldree6ok***
LocalFilePath	string	Yes	The name of the device that corresponds to the cache disk. You can call the DescribeGatewayCaches operation to query the name of the device.	/dev/vdb

Response parameters

Parameter	Type	Description	Example
	object
TaskId	string	The ID of the task.	t-0001xv7je357xv4s***
Message	string	The message that is returned.	successful
RequestId	string	The ID of the request.	EEFC9927-B097-446D-8FDA-F848C8B2C9E3
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "TaskId": "t-0001xv7je357xv4s***",
  "Message": "successful",
  "RequestId": "EEFC9927-B097-446D-8FDA-F848C8B2C9E3",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	LocationCloudRequired	You must specify a cloud gateway. Try again later.	You must specify a cloud gateway. Try again later.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	Invalid request. You must specify valid parameters in the request.
400	GatewayOperationNotAllowed	You cannot perform the operation when the gateway is in the current state.	You cannot perform the operation when the gateway is in the current state.
400	CacheInUse	The cache disk is in use.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.