1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
通过本接口创建多通道安全加速网关,包括云上网关(腾讯云创建和管理的网关)和自有网关(用户部署的私有网关),需要通过接口 DescribeMultiPathGateway,查询状态为 online 即创建成功。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateMultiPathGateway。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ZoneId | 是 | String | 站点 ID。 |
GatewayType | 是 | String | 网关类型,取值有: |
GatewayName | 是 | String | 网关名称,16 个字符以内,可用字符(a-z,A-Z,0-9,-,_)。 |
GatewayPort | 是 | Integer | 网关端口,范围 1~65535(除去 8888 )。 |
RegionId | 否 | String | 网关地域,GatewayType 取值为 cloud(云上网关)必填。可以从接口 DescribeMultiPathGatewayRegions 获取 RegionId 列表。 |
GatewayIP | 否 | String | 网关地址,GatewayType 取值为 private(自有网关)必填,使用该地址时,请确保该地址已录入腾讯云多通道安全加速网关系统。如未录入,需要在本接口调用前通过工单或者联系架构师把网关 IP 地址提前录入腾讯云多通道安全加速网关系统。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
GatewayId | String | 网关 ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建多通道安全加速网关(云上网关)
在指定站点( ZoneId 为 zone-27q0p0bal192 )下,创建云上网关,地域(RegionId)是北京(ap-beijing),端口(GatewayPort)为 8080。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMultiPathGateway
<公共请求参数>
{
"ZoneId": "zone-27q0p0bal192",
"GatewayType": "cloud",
"GatewayName": "EOMPGW-1",
"RegionId": "ap-beijing",
"GatewayPort": 8080
}
输出示例
{
"Response": {
"GatewayId": "mpgw-9d65563y6p",
"RequestId": "04e15f26-7a59-4e29-b297-1b43ed4ec691"
}
}
示例2 创建多通道安全加速网关(自有网关)
在指定站点( ZoneId 为 zone-27q0p0bal192 )下,创建自有网关,IP(GatewayIP) 是 49.7.248.202,端口(GatewayPort)为 443。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMultiPathGateway
<公共请求参数>
{
"GatewayType": "private",
"GatewayName": "private-1",
"ZoneId": "zone-27q0p0bal192",
"GatewayPort": 443,
"GatewayIP": "49.7.248.202"
}
输出示例
{
"Response": {
"GatewayId": "mpgw-ajf5qkoync",
"RequestId": "e8fef204-be7b-4a39-aee3-85b617651734"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |