1. 接口描述
接口请求域名: privatedns.tencentcloudapi.com 。
创建终端节点
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateEndPoint。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EndPointName | 是 | String | 终端节点名称 示例值:终端节点名 |
EndPointServiceId | 是 | String | 终端节点服务ID(vpc终端节点服务ID) 示例值:vpcsvc-gtd4gxa1 |
EndPointRegion | 是 | String | 终端节点地域,必须要和终端节点服务所属地域一致 示例值:ap-guangzhou |
IpNum | 否 | Integer | 终端节点ip数量 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EndPointId | String | 终端节点id 示例值:eid-ax8skcs0dg |
EndPointName | String | 终端节点名称 示例值:终端节点名 |
EndPointServiceId | String | 终端节点服务ID 示例值:终端节点服务ID |
EndPointVipSet | Array of String | 终端节点的IP列表 示例值:["10.0.0.13","10.0.0.14"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建终端节点
输入终端节点名称,客户自己的终端节点服务ID,以及终端节点服务对应的地域来创建一个终端节点
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEndPoint
<公共请求参数>
{
"EndPointName": "终端节点名",
"EndPointServiceId": "vpcsvc-gtd4gxa1",
"EndPointRegion": "ap-guangzhou"
}
输出示例
{
"Response": {
"RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
"EndPointId": "eid-scls023kfns",
"EndPointName": "终端节点名",
"EndPointServiceId": "vpcsvc-gtd4gxa1",
"EndPointVipSet": [
"10.0.0.13"
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.CreateVpcEndPointError | 创建终端节点异常。 |
FailedOperation.CreateVpcEndPointFailed | 创建终端节点失败。 |
FailedOperation.GetTmpCredFailed | 获取临时凭证失败 |
InternalError | 内部错误。 |
InternalError.UndefiendError | 错误未定义。 |
InvalidParameter | 参数错误。 |
InvalidParameter.EndPointServiceNotExist | 终端节点服务不存在。 |
InvalidParameterValue.UinNotInWhiteList | uin没有录入白名单,无权限访问 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.ServiceNotSubscribed | 私有域解析服务未开通。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ServiceWhiteListNotAdded | 未添加平台账号到当前终端节点服务的白名单内。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.RoleUnAuthorized | 角色未授权。 |
UnauthorizedOperation.UnauthorizedAccount | 未实名账号。 |
UnknownParameter | 未知参数错误。 |