1. 接口描述
接口请求域名: ga2.tencentcloudapi.com 。
创建七层转发规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateForwardingRule。 |
| Version | 是 | String | 公共参数,本接口取值:2025-01-15。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| GlobalAcceleratorId | 是 | String | 全球加速实例ID。 示例值:ga-ask56kjh |
| ListenerId | 是 | String | 监听器ID。 示例值:lsr-kzjzfs7n |
| ForwardingPolicyId | 是 | String | 策略ID。 示例值:dm-dz058e4q |
| RuleConditions.N | 是 | Array of RuleCondition | 七层转发规则条件信息。 |
| RuleActions.N | 是 | Array of RuleAction | 七层转发规则行为信息。 |
| OriginHeaders.N | 否 | Array of OriginHeader | 回源Header信息。 |
| EnableOriginSni | 否 | Boolean | 是否开启回源sni。 示例值:True |
| OriginSni | 否 | String | 回源sni。 |
| OriginHost | 否 | String | 回源host。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 异步任务ID。 示例值:e1326769-29a9-43d5-8fbb-6af2e7165328 |
| ForwardingRuleId | String | 七层转发规则ID。 示例值:rule-kfn3oc78 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建七层转发规则
输入示例
POST / HTTP/1.1
Host: ga2.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateForwardingRule
<公共请求参数>
{
"GlobalAcceleratorId": "ga-80bzejka",
"ListenerId": "lsr-nd3qmz7h",
"ForwardingPolicyId": "dm-kzk3neks",
"RuleConditions": [
{
"RuleConditionType": "Path",
"RuleConditionValue": [
"/a"
]
}
],
"RuleActions": [
{
"RuleActionType": "Drop"
}
],
"OriginHeaders": [
{
"Key": "key-123",
"Value": "value-123"
}
],
"EnableOriginSni": true,
"OriginSni": "123",
"OriginHost": "www.bbb.com"
}
输出示例
{
"Response": {
"RequestId": "f7be96f3-c499-4efe-badd-0178c2921d8f",
"TaskId": "6fa13601-49eb-4982-abee-513fbab41fc1",
"ForwardingRuleId": "rule-kfn3oc78"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.AsciiCharacters | 只能是可打印ASCII字符。 |
| InvalidParameterValue.InstanceMismatch | 实例对象 %(value)s 关系不匹配。 |
| InvalidParameterValue.SpecialCharacters | 参数值 %(value)s 不能含有特殊字符 %(key)s。 |
| MissingParameter | 缺少参数错误。 |
| UnsupportedOperation.ForwardGroupForwardingRuleUnsupportedDefaultEndpointGroup | 转发规则不支持配置默认终端节点组。 |