UpgradeGateway - 升级网关

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

根据网关ID对指定的网关进行升级。

接口说明

调用该接口时,您需要注意:

  • 升级过程中,无法响应其他发送的请求。

  • 仅支持网关状态为运行中(Running)、已激活(Activated)时调用此接口。

  • 高可用网关的升级由系统内部自动管理,如果尝试对高可用网关进行手动升级,系统将返回 BadRequest 错误。

警告 升级网关会导致您的业务暂时中断,请谨慎操作。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

gw-0001xv7je3580031y***

返回参数

名称类型描述示例值
object
TaskIdstring

任务 ID。

t-0001xv7je3580412***
Messagestring

请求结果描述。

successful
RequestIdstring

请求 ID。

CB300009-3850-4107-B291-59BDB4EDA183
Codestring

状态码。状态码为 200 表示请求成功。

Code
Successboolean

请求是否成功。可取值如下:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "TaskId": "t-0001xv7je3580412***",
  "Message": "successful",
  "RequestId": "CB300009-3850-4107-B291-59BDB4EDA183",
  "Code": "Code",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400EmptyGatewayIdYou must enter a valid ID for the gateway.网关ID不能为空。
400GatewayNotExistThe specified gateway does not exist. You must specify a valid parameter.网关不存在,请确认输入参数是否正确。
400GatewayOperationNotAllowedYou cannot perform the operation when the gateway is in the current state.网关当前状态不允许执行该操作。
400GatewayInOperationThe gateway is processing requests . Try again later.网关正在进行操作中,请稍后再试。
400BadRequestInvalid request. You must specify valid parameters in the request. 非法请求,请检查请求参数。

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

变更历史

变更时间变更内容概要操作
2023-03-14OpenAPI 错误码发生变更查看变更详情