Upgrade a Cloud Storage Gateway Instance Class via API - Cloud Storage Gateway - Alibaba Cloud - Cloud Storage Gateway

Operation description

Description

Note the following when you call this operation:

Before you call this operation, make sure that you understand the pricing of Cloud Storage Gateway.
If your gateway is a subscription instance, you must use the purchase URL returned in the response to complete the upgrade.
You can call the DescribeGatewayModificationClasses operation to query the gateway classes to which you can upgrade a specified online gateway.
You can only upgrade an online gateway. You cannot downgrade a gateway.

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

hcs-sgw:ModifyGatewayClass

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-0001xv7580031yzun***
GatewayClass	string	Yes	The gateway class to which you want to upgrade. You can call the DescribeGatewayModificationClasses operation to query the available gateway classes. Valid values: Basic Standard Enhanced Advanced	Enhanced

Response elements

Element	Type	Description	Example
	object
BuyURL	string	The URL used to complete the upgrade. This parameter is returned only for subscription gateways.	https://common-buy-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade
TaskId	string	The ID of the task.	t-0001xv7je3580bx6v***
RequestId	string	The ID of the request.	395B1136-982E-4F95-BDCE-7323FFEF499E
Message	string	The returned message.	successful
Code	string	The status code. A value of 200 indicates that the call was successful.	200
Success	boolean	Indicates whether the call was successful.	true

Examples

Success response

JSON format

{
  "BuyURL": "https://common-buy-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&instanceId=gw-000c6hshwukjwc7e1***#/upgrade",
  "TaskId": "t-0001xv7je3580bx6v***",
  "RequestId": "395B1136-982E-4F95-BDCE-7323FFEF499E",
  "Message": "successful",
  "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	InvalidGatewayClass	The specified specification of the gateway is invalid.	The specified specification of the gateway is invalid.
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	LocationCloudRequired	You must specify a cloud gateway. Try again later.	You must specify a cloud gateway. Try again later.
400	GatewayStatusRunningRequired	The gateway is not in the Running state. Try again later.	The gateway is not in the Running state. Try again later.
400	GatewayClassUpgradeOnly	You can upgrade only the specification of the gateway.	You can upgrade only the specification of the gateway.
400	NoAvailableOnlineResource	There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.	There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.