AI 助理
备案控制台
文档
输入文档关键字查找
首页 微服务引擎 开发参考 API参考（mse） API参考指南 API目录 云原生网关 网关管理 AddGateway - 添加网关

AddGateway - 添加网关

更新时间：
产品详情
相关技术圈
我的收藏

添加网关。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:AddGatewaycreate
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/*
    无
无

请求参数

名称类型必填描述示例值
Namestring否

网关名称。

test-ceshi
Regionstring是

地域。

cn-hangzhou
SlbSpecstring否

私网 SLB 规格（适用于传统实例）。

  • 简约型 (slb.s1.small)
  • 标准型 1 (slb.s2.small)
  • 标准型 I(slb.s2.medium)
  • 高阶型 1 (slb.s3.small)
  • 高阶型 I(slb.s3.medium)
  • 超强型 I (slb.s3.large)
说明 传统实例：创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
slb.s2.small
Vpcstring是

专有网络 ID。

vpc-bp15mncnrtm83uauxd1xb
VSwitchIdstring否

主交换机 ID。

vsw-bp1q8th57frl5khj2li43
Specstring否

节点规格（购买传统实例时指定）。

  • MSE_GTW_16_32_200_c(16C32G)
  • MSE_GTW_2_4_200_c(2C4G)
  • MSE_GTW_4_8_200_c(4C8G)
  • MSE_GTW_8_16_200_c(8C16G)
MSE_GTW_2_4_200_c
Replicainteger否

节点数量（购买传统实例时指定）。

2
InternetSlbSpecstring否

公网 SLB 规格（适用于传统实例）。

  • 简约型 (slb.s1.small)
  • 标准型 1 (slb.s2.smal)
  • 标准型 I(slb.s2.medium)
  • 高阶型 1 (slb.s3.small)
  • 高阶型 I(slb.s3.medium)
  • 超强型 I (slb.s3.large)
说明 传统实例：创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
slb.s2.small
VSwitchId2string否

备交换机 ID。

vsw-wz9bu6o5vsvitt5mrxo6s
EnterpriseSecurityGroupboolean否

是否企业安全组类型。

false
EnableHardwareAccelerationboolean否

是否开启硬件加速。

false
EnableXtraceboolean否

是否启用链路追踪。

false
XtraceRatiostring否

链路追踪采样率，取值[1,100]。

10
EnableSlsboolean否

是否启用 SLS 日志投递。

false
Tagarray<object>否

网关标签。

object否

标签对象。

Keystring否

标签 Key。

key
Valuestring否

标签 Value。

value
ResourceGroupIdstring否

资源组 ID。

rg-acfm34x43l*****
RequestParsstring否

扩展字段。

{}
ZoneInfoarray<object>是

可用区信息。

object是

可用区信息。

ZoneIdstring否

可用区 ID。

cn-shenzhen-e
VSwitchIdstring否

交换机 ID。

vsw-bp*****
ChargeTypestring否

付费类型（购买传统实例时指定）。

枚举值：
  • PREPAY：包年包月。
  • POSTPAY：按量付费。
POSTPAY
MserVersionstring否

网关产品类型：

  • mse_pro：传统实例
  • mse_serverless：Serverless
mse_pro
NlbNetworkTypestring否

代购的 NLB 网络类型：

  • pubnet：公网
  • privatenet：私网
  • privatepubnet：公网+私网
说明 传统实例：创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
pubnet
ClbNetworkTypestring否

代购按 LCU 计费的 CLB 的网络类型：

  • pubnet：公网
  • privatenet：私网
  • privatepubnet：公网+私网
说明 传统实例：创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明 Serverless 实例：创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
pubnet
AcceptLanguagestring否

返回信息的语言类型：

  • zh：中文
  • en：英文
zh

返回参数

名称类型描述示例值
object

数据结构。

RequestIdstring

请求 ID。

2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

  • 当请求成功时，返回成功信息。
  • 当请求失败时，返回失败原因。
请求处理成功
Codeinteger

返回值。

200
Successboolean

请求结果，取值如下：

  • true：请求成功。
  • false：请求失败。
true
Dataobject

返回数据。

GatewayUniqueIdstring

网关唯一标识 ID。

gw-5017305290e14cebbrvec4a5****

示例

正常返回示例

JSON格式

{
  "RequestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": {
    "GatewayUniqueId": "gw-5017305290e14cebbrvec4a5****"
  }
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求： %s
400InvalidParameterParameter error:%s请求参数错误：%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口：%s
404NotFoundNot found:%s资源不存在：%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试：%s

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

变更历史

变更时间变更内容概要操作
2024-06-21OpenAPI 入参发生变更查看变更详情
2023-10-11OpenAPI 入参发生变更查看变更详情
2023-05-09OpenAPI 入参发生变更查看变更详情
2023-05-09OpenAPI 入参发生变更查看变更详情
2023-04-17OpenAPI 入参发生变更查看变更详情
2021-12-29OpenAPI 入参发生变更查看变更详情
2021-12-29OpenAPI 入参发生变更查看变更详情
上一篇：网关管理下一篇：ListGatewayZone - 获取网关可用区列表
文档推荐