Expand OSS Gateway Public Bandwidth via OpenAPI - Cloud Storage Gateway

Operation description

When you call this operation, note the following:

If the gateway and the target OSS bucket are in different regions, you must call this operation to expand the public bandwidth for cross-region mounting.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbv****
NewNetworkBandwidth	integer	No	The new network bandwidth. Unit: Mbit/s. Valid values: a value that is greater than the current bandwidth up to 200. Note This parameter is required. The peak bandwidth is for reference only and does not indicate a service level agreement (SLA). It specifies the upper limit of the bandwidth.	10

Response parameters

Parameter	Type	Description	Example
	object
BuyURL	string	The payment URL for the subscription gateway.	https://common-buy-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i
TaskId	string	The ID of the task.	t-0001xv7je357xv4s****
RequestId	string	The ID of the request.	89398CFB-4EB6-4C7E-BB3C-EF213AC8****
Message	string	The description of the request result.	successful
Code	string	The status code. A value of 200 indicates that the request is successful. Other values indicate that the request failed.	200
Success	boolean	The result of the request. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "BuyURL": "https://common-buy-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=UPGRADE&i",
  "TaskId": "t-0001xv7je357xv4s****",
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8****",
  "Message": "successful",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.