Update iSCSI Gateway Block Volume via UpdateGatewayBlockVolume API - Cloud Storage Gateway

Operation description

Before you call this operation, note the following:

You have created and deployed an iSCSI gateway and configured a block volume.
This operation updates all exposed parameters of the block volume. If you do not want to update a specific parameter, you must specify its initial value in the request. Otherwise, the parameter is reset to its default value.

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:UpdateGatewayBlockVolume

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq***
IndexId	string	Yes	The index ID. You can call the DescribeGatewayBlockVolumes operation to query the index ID.	NFSalex***
Size	integer	No	The size of the block volume. Unit: GB. Valid values: 1 to 262144. Default value: 100. Note This parameter is invalid when recovery is enabled.	100
ChapEnabled	boolean	No	Specifies whether to enable Challenge-Handshake Authentication Protocol (CHAP) authentication for the iSCSI volume. Inbound CHAP is supported. Valid values: false (default): CHAP authentication is disabled. true: CHAP authentication is enabled.	false
ChapInUser	string	No	The username for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The username must be 1 to 32 characters in length and can contain letters and digits. Note This parameter is invalid when CHAP authentication is disabled.	user
ChapInPassword	string	No	The password for inbound CHAP authentication when CHAP authentication is enabled for the iSCSI volume. The password must be 12 to 16 characters in length and can contain letters, digits, and the following special characters: !, @, #, $, %, ^, &, and . Note* This parameter is invalid when CHAP authentication is disabled.	ChapInPassword

Response parameters

Parameter	Type	Description	Example
	object
TaskId	string	The ID of the task.	t-000avsri6tlyddgfe***
Message	string	The message that is returned.	successful
RequestId	string	The ID of the request.	EBAF769F-2E88-4D81-AF1E-A34FAACF9***
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-000avsri6tlyddgfe***",
  "Message": "successful",
  "RequestId": "EBAF769F-2E88-4D81-AF1E-A34FAACF9***",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.BlockVolume.%s	The specified field %s for block volume is invalid. Please check it again.	The specified block volume parameter is invalid. You must specify a valid parameter.
400	VersionNotSupported.BlockVolume.%s	The specified field %s for block volume is not supported by current gateway version. Please check it again.	The specified block volume parameter for the gateway is not compatible with the gateway version. You must specify a valid parameter.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.