私有域解析 Private DNS 创建自定义转发规则-私有域解析相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： privatedns.tencentcloudapi.com 。

创建自定义转发规则

默认接口请求频率限制：5次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateForwardRule。
Version	是	String	公共参数，本接口取值：2020-10-28。
Region	否	String	公共参数，本接口不需要传递此参数。
RuleName	是	String	转发规则名称示例值：转发规则1
RuleType	是	String	转发规则类型：云上到云下DOWN，云下到云上UP 示例值：UP
ZoneId	是	String	私有域ID，可在私有域列表页面查看示例值：zone-1dsi8dsg
EndPointId	是	String	终端节点ID 示例值：eid-ml0mysdpsaf

3. 输出参数

参数名称	类型	描述
RuleId	String	转发规则ID 示例值：fid-afd2dcgsa3
RuleName	String	转发规则名称示例值：转发规则1
RuleType	String	转发规则类型示例值：DOWN
ZoneId	String	私有域ID 示例值：zone-af2fdsfa
EndPointId	String	终端节点ID 示例值：eid-afsdf2sa
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建转发规则

输入示例

POST / HTTP/1.1
Host: privatedns.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"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.UndefiendError	错误未定义。
InvalidParameter	参数错误。
InvalidParameter.EndPointNotExists	终端节点不存在。
InvalidParameter.ForwardRuleZoneRepeatBind	私有域已经绑定过转发规则。
InvalidParameter.ZoneNotExists	解析域不存在。
InvalidParameterValue	参数取值错误。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。
UnsupportedOperation.FrequencyLimit	接口调用超过限频。