接口请求域名: privatedns.intl.tencentcloudapi.com 。
创建自定义转发规则
默认接口请求频率限制:5次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateForwardRule。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| RuleName | 是 | String | 转发规则名称 |
| RuleType | 是 | String | 转发规则类型:云上到云下DOWN,云下到云上UP |
| ZoneId | 是 | String | 私有域ID,可在私有域列表页面查看 |
| EndPointId | 是 | String | 终端节点ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 转发规则ID |
| RuleName | String | 转发规则名称 |
| RuleType | String | 转发规则类型 |
| ZoneId | String | 私有域ID |
| EndPointId | String | 终端节点ID |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: privatedns.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateForwardRule
<公共请求参数>
{
"RuleType": "UP",
"ZoneId": "zone-fadsvas",
"RuleName": "规则1",
"EndPointId": "eid-93kvksadf"
}
{
"Response": {
"RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
"RuleType": "UP",
"RuleId": "fid-afdfaf2fsad",
"ZoneId": "zone-fadsvas",
"EndPointId": "eid-93kvksadf",
"RuleName": "规则1"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.UndefiendError | 错误未定义。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.EndPointNotExists | 终端节点不存在。 |
| InvalidParameter.ForwardRuleZoneRepeatBind | 私有域已经绑定过转发规则。 |
| InvalidParameter.ZoneNotExists | 解析域不存在。 |
| InvalidParameterValue | 参数取值错误。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.FrequencyLimit | 接口调用超过限频。 |
文档反馈