Update Gateway Name and Description with ModifyGateway API - Cloud Storage 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 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:ModifyGateway

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-0001xv7je3580031y***
Name	string	Yes	The new name of the gateway. The name must be 1 to 60 characters in length. It can contain uppercase letters, lowercase letters, Chinese characters, digits, periods (.), underscores (_), or hyphens (-). The name must start with an uppercase letter, a lowercase letter, or a Chinese character.	alex***
Description	string	No	The new description of the gateway. The description can be 0 to 255 characters in length.

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The response message.	successful
RequestId	string	The ID of the request.	220E7407-DF77-428D-8955-B02CF8F82D07
GatewayId	string	The ID of the gateway.	gw-0001xv7je3580031y***
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

{
  "Message": "successful",
  "RequestId": "220E7407-DF77-428D-8955-B02CF8F82D07",
  "GatewayId": "gw-0001xv7je3580031y***",
  "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	EmptyGatewayName	You must enter a valid name for the gateway.	You must enter a valid name for the gateway.
400	InvalidGatewayName	The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
400	DescriptionOverLimit	The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.	The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.
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	DuplicateGatewayName	The specified name of the gateway already exists. You must specify a valid name.	The specified name of the gateway already exists. You must specify a valid name.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.