1. 接口描述
接口请求域名： tem.tencentcloudapi.com 。
修改网关的转发配置
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyGatewayIngress。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentId | 否 | String | 环境 ID 示例值：en-xxx |
| GatewayName | 否 | String | 网关名称 示例值：gateway |
| GatewayType | 否 | String | 网关类型，如 clb 示例值：clb |
| Name | 否 | String | 转发配置名称 示例值：xxx |
| Rules.N | 否 | Array of IngressRule | rules 配置 示例值：{} |
| Mixed | 否 | Boolean | 是否混合 https，默认 false，可选值 true 代表有 https 协议监听 示例值：false |
| Tls.N | 否 | Array of IngressTls | tls 配置 示例值：{} |
| RewriteType | 否 | String | 重定向模式，可选值： - AUTO（自动重定向http到https） - NONE（不使用重定向） 示例值：NONE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Boolean | 是否成功 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改网关的转发配置
修改网关的转发配置
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyGatewayIngress
<公共请求参数>
{
"EnvironmentId": "xx",
"GatewayType": "clb",
"GatewayName": "xx",
"Name": "xx",
"Rules": [
{
"Protocol": "xx",
"Host": "xx",
"Http": {
"Paths": [
{
"Path": "xx",
"Backend": {
"ServiceName": "xx",
"ServicePort": 443
}
}
]
}
}
],
"Tls": [
{
"CertificateId": "xx",
"Hosts": [
"xxx.com"
],
"SecretName": "xx"
}
],
"Mixed": true,
"RewriteType": "NONE"
}输出示例
{
"Response": {
"RequestId": "81f74023-563c-437d-abf7-8139449ef178",
"Result": true
}
}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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ModifyGatewayIngressError | 修改网关的转发配置失败。 |
| InvalidParameterValue.IngressRulesConflict | 自动重定向规则冲突，请检查是否存在同一个path的http/https转发。 |
| UnauthorizedOperation.UnauthorizedOperation | 未授权。 |
