调用UpdateIpv4GatewayAttribut修改IPv4网关的名称或描述信息。
接口说明
UpdateIpv4GatewayAttribute 接口不支持并发修改同一个 IPv4 网关的名称或描述信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:UpdateIpv4GatewayAttribute | update | *Ipv4Gateway acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#ipv4gatewayId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Ipv4GatewayId | string | 是 | 要修改名称或描述信息的 IPv4 网关的实例 ID。 | ipv4gw-5tsnc6s4ogsedtp3k**** |
| Ipv4GatewayName | string | 否 | 要修改的 IPv4 网关实例的名称，即修改后的名称。 | newname |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| Ipv4GatewayDescription | string | 否 | 要修改的 IPv4 网关实例的描述信息，即修改后的描述信息。 | new |
| RegionId | string | 是 | 要修改名称或描述信息的 IPv4 网关实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | ap-southeast-6 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "671CEB03-C98D-5916-950C-C55B0BD06621"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ResourceNotFound.Ipv4Gateway | The specified resource ipv4Gateway is not found. | 未找到指定的Ipv4网关，无法删除 |
| 400 | IncorrectStatus.Ipv4Gateway | The status of %s [%s] is incorrect. | 指定的Ipv4Gateway处于非稳态，请稍后重试 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-07 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |