UpgradeGateway - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Updates a gateway.

Operation description

Usage notes

When you call this operation, take note of the following items:

You can update a gateway that is only in the Running or Activated state.
During the update process, the gateway cannot respond to other requests.

Warning Updating gateways will cause temporary business interruptions. Exercise caution when performing this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hcs-sgw:UpgradeGateway	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The gateway ID.	gw-0001xv7je3580031y***

Response parameters

Parameter	Type	Description	Example
	object
TaskId	string	The task ID.	t-0001xv7je3580412***
Message	string	The returned message.	successful
RequestId	string	The request ID.	CB300009-3850-4107-B291-59BDB4EDA183
Code	string	The status code. The status code 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "TaskId": "t-0001xv7je3580412***",
  "Message": "successful",
  "RequestId": "CB300009-3850-4107-B291-59BDB4EDA183",
  "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	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	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. 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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-14	The Error code has changed	View Change Details