1. 接口描述
接口请求域名: domain.tencentcloudapi.com 。
用于合作商对预释放域名进行预留。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ReservedPreDomains。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainList.N | 是 | Array of String | 预约预释放域名列表 示例值:["tencent01.com","tencent02.com"] |
TemplateId | 是 | String | 模板ID 示例值:tmpl-qdpjnfe8 |
IsAutoPay | 否 | Integer | 结束后是否自动支付尾款,默认开启 传入1关闭 示例值:0 |
IsBidAutoPay | 否 | Integer | 结束后是否自动进行梯度保证金扣除,默认开启 传入1关闭 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SucDomainList | Array of String | 预定成功域名列表 示例值:["tencent01.com","tencent02.com"] |
FailDomainList | Array of FailReservedDomainInfo | 预定失败域名列表 |
SucDomains | Array of SucDomainInfo | 域名预定成功详情 示例值:[{"tencent.com","P0011702977661022561"}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReservedPreDomains
<公共请求参数>
{
"DomainList": [
"aksdwe1.cn",
"aksdwe2.cn"
],
"TemplateId": "tmpl-abxxxxxx"
}
输出示例
{
"Response": {
"SucDomainList": [
"aksdwe1.cn"
],
"FailDomainList": [
{
"Domain": "aksdwe2.cn",
"FailReason": "域名下架"
}
],
"RequestId": "xxxx-xxx-xxx-xxxx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.UinNotWhiteListErr | 用户不再白名单列表,无法调用该接口 |
InternalError.DbError | 数据库报错。 |
InvalidParameterValue.InvalidParameterFormat | 表单参数取值错误。 |