ModifyGateway - 修改网关基本信息_云存储网关(CSG)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:ModifyGateway

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-0001xv7je3580031y***
Name	string	是	修改后的网关名称。长度限制 1~60 个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。	alex***
Description	string	否	修改后的网关描述。长度限制 0~255 个字符。	测试使用

返回参数

名称	类型	描述	示例值
	object
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	220E7407-DF77-428D-8955-B02CF8F82D07
GatewayId	string	网关 ID。	gw-0001xv7je3580031y***
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "Message": "successful",
  "RequestId": "220E7407-DF77-428D-8955-B02CF8F82D07",
  "GatewayId": "gw-0001xv7je3580031y***",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	EmptyGatewayId	You must enter a valid ID for the gateway.	网关ID不能为空。
400	EmptyGatewayName	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.	无效的网关名称，网关名称长度限制1~60个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。
400	DescriptionOverLimit	The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.	网关描述超过最大长度，最大限度为255个字符。
400	GatewayNotExist	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.	存在同名的网关，请选用其它名称。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。