DeployGateway - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Operation description

When you call this operation, note the following:

This operation supports only pay-as-you-go cloud-based file gateways.
You can deploy only cloud-based file gateways that are in the Initialized status.
After the gateway is deployed, you can call the DescribeGateway operation to query the status of the gateway. The gateway is successfully deployed if its status is Running.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-0001xv7je3580031y***
GatewayClass	string	No	The gateway class. Valid values: Basic Standard Enhanced Advanced	Basic

Response parameters

Parameter	Type	Description	Example
	object
TaskId	string	The ID of the task.	t-0001xv7je35800307***
Message	string	The description of the request result.	successful
RequestId	string	The ID of the request.	8FEAFE9D-66C2-46AB-833B-35269EC7524C
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-0001xv7je35800307***",
  "Message": "successful",
  "RequestId": "8FEAFE9D-66C2-46AB-833B-35269EC7524C",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	Invalid request. You must specify valid parameters in the request.
400	InvalidGatewayLocation	The specified location of the gateway is invalid.	The specified location of the gateway is invalid.
400	InvalidGatewayClass	The specified specification of the gateway is invalid.	The specified specification of the gateway is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.