调用ModifyGateway可对指定网关的基本信息进行修改。包括网关的名称和描述。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ModifyGateway

系统规定参数。取值：ModifyGateway。
GatewayId String 是 gw-0001xv7je3580031y***

网关ID。
Name String 是 alex***

修改后的网关名称。长度限制1~60个字符，可以包含大小写字母，中文，数字，“.”，“_”或“-”，同时必须以大小写字母或者中文开头。
Description String 否 测试使用

修改后的网关描述。长度限制0~255个字符。

返回数据

名称 类型 示例值 描述
Code String 200

状态码。状态码为200表示请求成功。
GatewayId String gw-0001xv7je3580031y***

网关ID。
Message String successful

请求结果描述。
RequestId String 220E7407-DF77-428D-8955-B02CF8F82D07

请求ID。
Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyGateway
&GatewayId=gw-0001xv7je3580031y***
&Name=alex***
&<公共请求参数>

正常返回示例

XML 格式 

<ModifyGatewayResponse>
      <Message>successful</Message>
      <RequestId>220E7407-DF77-428D-8955-B02CF8F82D07</RequestId>
      <GatewayId>gw-0001xv7je3580031***</GatewayId>
      <Code>200</Code>
      <Success>true</Success>
</ModifyGatewayResponse>

JSON 格式 

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

错误码

HttpCode 错误码 错误信息 描述
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. 存在同名的网关，请选用其它名称。

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