Automate Storage Volume Creation via ENS API - ENS

Creates a storage volume.

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 supports 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

ens:CreateStorageVolume

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	sgw-****
StorageId	string	Yes	The ID of the storage medium.	si-****
EnsRegionId	string	Yes	The ID of the node.	cn-shenzhen-3
IsEnable	string	No	Indicates whether the volume is enabled. Valid values: 1 (default): The volume is enabled. 0: The volume is disabled.	1
IsAuth	string	No	Specifies whether to enable authentication. Valid values: 1: Authentication is enabled. 0 (default): Authentication is disabled.	0
AuthProtocol	string	No	The authentication protocol. Set the value to CHAP.	CHAP
AuthUser	string	No	The username of the CHAP protocol.	User
AuthPassword	string	No	The password of the CHAP protocol.	Password
VolumeName	string	No	The name of the volume. The name must be 2 to 128 characters in length. The name cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).	testVolumeName
Description	string	No	The description of the volume. The description must be 2 to 128 characters in length. The description cannot start with `http://` or `https://`.	testDescription

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	7030AB96-57CF-1C68-9FEE-D60E547FD79C
VolumeId	array	An array of volume IDs.
	string	The ID of the created volume.	["sv-***"]

Examples

Success response

JSON format

{
  "RequestId": "7030AB96-57CF-1C68-9FEE-D60E547FD79C",
  "VolumeId": [
    "[\"sv-***\"]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	OrderFailed	Order failed
400	SaleControl.VerificationFailed	You did not pass the salecontrol verification.Please contact the product.	Failed to pass the sales constraint verification when you create the resource.
400	ERROR_VOLUME_STORAGE_STATUS	The cloud disk cannot be operated
400	ERROR_VOLUME_STORAGE_BINDED	The cloud disk has been bound
400	ERROR_VOLUME_PROTOCOL	The wrong protocol
400	ERROR.STORAGE.BINDED	The storageId has been bound.	The specified storage device (such as the cloud disk ID) has been bound. Batch operations are not supported.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.