Create a Storage Gateway via API - Edge Node Service

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderDetails	array<object>	Yes	The array of orders.
	object	Yes
EnsRegionId	string	Yes	The ID of the node.	cn-shenzhen-3
GatewayType	string	Yes	The type of the gateway. Set this parameter to 1. 1 indicates iSCSI.	1
VpcId	string	Yes	The ID of the VPC.	n-123
GatewayName	string	No	The name of the gateway. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (.), underscores (_), and hyphens (-).	testGatewayName
Description	string	No	The description of the gateway. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.	testDescription

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	EA3758E0-8899-17D3-9526-5F62CF33A586
AllocationId	array<object>	The list of created nodes.
	object
InstanceId	string	The ID of the instance.	e426409223
EnsRegionId	string	The ID of the node.	cn-chengdu-telecom-4
BizStatusCode	string	The success status code. PartSuccess: partially succeeded. AllSuccess: all succeeded.	AllSuccess
UnAllocationId	array<object>	The list of nodes that are not created.
	object
InstanceId	string	The ID of the instance.	e426409258
EnsRegionId	string	The ID of the node.	cn-chengdu-26

Examples

Success response

JSON format

{
  "RequestId": "EA3758E0-8899-17D3-9526-5F62CF33A586",
  "AllocationId": [
    {
      "InstanceId": "e426409223",
      "EnsRegionId": "cn-chengdu-telecom-4"
    }
  ],
  "BizStatusCode": "AllSuccess",
  "UnAllocationId": [
    {
      "InstanceId": "e426409258",
      "EnsRegionId": "cn-chengdu-26"
    }
  ]
}

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	Invalid%s	The specified parameter %s is invalid.
400	SaleControlVerificationFailedStock	Inventory sales constraint verification failed, please re-match, or contact the product.	Inventory sales constraint verification failed, please re-select
400	SaleControlVerificationFailedRegion	The node sales constraint verification failed, please re-select or contact the product.	Node sales constraint verification failed, please re-select
400	%s	Some of the bulk orders failed, please try again:%s.	Some of the bulk orders failed, please try again:%s
400	NoPermission	Permission denied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.