添加网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mse:AddGateway | create | *Gateway acs:mse:{#regionId}:{#accountId}:instance/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 网关名称。 | test-ceshi |
Region | string | 是 | 地域。 | cn-hangzhou |
SlbSpec | string | 否 | 私网 SLB 规格(适用于传统实例)。
说明
传统实例:创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明
Serverless 实例:创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
| slb.s2.small |
Vpc | string | 是 | 专有网络 ID。 | vpc-bp15mncnrtm83uauxd1xb |
VSwitchId | string | 否 | 主交换机 ID。 | vsw-bp1q8th57frl5khj2li43 |
Spec | string | 否 | 节点规格(购买传统实例时指定)。
| MSE_GTW_2_4_200_c |
Replica | integer | 否 | 节点数量(购买传统实例时指定)。 | 2 |
InternetSlbSpec | string | 否 | 公网 SLB 规格(适用于传统实例)。
说明
传统实例:创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明
Serverless 实例:创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
| slb.s2.small |
VSwitchId2 | string | 否 | 备交换机 ID。 | vsw-wz9bu6o5vsvitt5mrxo6s |
EnterpriseSecurityGroup | boolean | 否 | 是否企业安全组类型。 | false |
EnableHardwareAcceleration | boolean | 否 | 是否开启硬件加速。 | false |
EnableXtrace | boolean | 否 | 是否启用链路追踪。 | false |
XtraceRatio | string | 否 | 链路追踪采样率,取值[1,100]。 | 10 |
EnableSls | boolean | 否 | 是否启用 SLS 日志投递。 | false |
Tag | array<object> | 否 | 网关标签。 | |
object | 否 | 标签对象。 | ||
Key | string | 否 | 标签 Key。 | key |
Value | string | 否 | 标签 Value。 | value |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfm34x43l***** |
RequestPars | string | 否 | 扩展字段。 | {} |
ZoneInfo | array<object> | 是 | 可用区信息。 | |
object | 是 | 可用区信息。 | ||
ZoneId | string | 否 | 可用区 ID。 | cn-shenzhen-e |
VSwitchId | string | 否 | 交换机 ID。 | vsw-bp***** |
ChargeType | string | 否 | 付费类型(购买传统实例时指定)。 枚举值:
| POSTPAY |
MserVersion | string | 否 | 网关产品类型:
| mse_pro |
NlbNetworkType | string | 否 | 代购的 NLB 网络类型:
说明
传统实例:创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明
Serverless 实例:创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
| pubnet |
ClbNetworkType | string | 否 | 代购按 LCU 计费的 CLB 的网络类型:
说明
传统实例:创建时只能在 NLB、按 LCU 计费的 CLB、按规格的 CLB 中选择一种代购
说明
Serverless 实例:创建时只能在 NLB、按 LCU 计费的 CLB 中选择一种代购
| pubnet |
AcceptLanguage | string | 否 | 返回信息的语言类型:
| zh |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
"HttpStatusCode": 200,
"Message": "请求处理成功",
"Code": 200,
"Success": true,
"Data": {
"GatewayUniqueId": "gw-5017305290e14cebbrvec4a5****"
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalRequest | Invalid request:%s | 非法请求: %s |
400 | InvalidParameter | Parameter error:%s | 请求参数错误:%s |
403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s |
404 | NotFound | Not found:%s | 资源不存在:%s |
500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-21 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-10-11 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-17 | OpenAPI 入参发生变更 | 查看变更详情 |
2021-12-29 | OpenAPI 入参发生变更 | 查看变更详情 |
2021-12-29 | OpenAPI 入参发生变更 | 查看变更详情 |