更新私有网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eas:UpdateGateway | update |
|
| 无 |
请求语法
PUT /api/v2/gateways/{ClusterId}/{GatewayId} HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求 Body。 | |
InstanceType | string | 否 | 私有网关使用的机型。取值如下:
| 2c4g |
Name | string | 否 | 私有网关别名。 | mygateway1 |
EnableIntranet | boolean | 否 | 开启内网访问(默认值为 true)。 枚举值:
| true |
EnableInternet | boolean | 否 | 开启公网访问(默认值为 false)。 枚举值:
| false |
IsDefault | boolean | 否 | 是否默认私有网关。 | true |
Replicas | integer | 否 | 私有网关节点数。 | 2 |
GatewayId | string | 是 | 私有网关 ID。如何获取私有网关 ID,请参见 ListResources 接口返回结果中的 private_gateway_id 字段。 | gw-1uhcqmsc7x22****** |
ClusterId | string | 是 | 私有网关所在区域。 | cn-wulanchabu |
返回参数
示例
正常返回示例
JSON
格式
{
"GatewayId": "gw-1uhcqmsc7x22******",
"RequestId": "40325405-579C-4D82***",
"Message": "Gateway is updated"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-31 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-11-16 | OpenAPI 入参发生变更 | 查看变更详情 |