1. 接口描述
接口请求域名: domain.tencentcloudapi.com 。
合作商用于查询预约预释放状态信息内容
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeReservedPreDomainInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainList.N | 否 | Array of String | 域名,每次最多支持500条域名查询 示例值:["tencent.com","tencent.com01"] |
ReservedStatus | 否 | Integer | 状态,用于筛选,可不填写(1. 成功 2. 失败(失败Reason字段将会被赋值)3. 域名交割中 4. 域名交割完成 5. 预约 6. 竞价) 示例值:1 |
ReservedTimeSort | 否 | String | 根据预约时间排序,仅支持:"desc","asc"。 示例值:desc |
Limit | 否 | Integer | 条数 示例值:20 |
Offset | 否 | Integer | 偏移量 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ReservedPreDomainInfoList | Array of ReservedPreDomainInfo | 预释放预约列表 |
Total | Integer | 总数 示例值:300 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReservedPreDomainInfo
<公共请求参数>
{
"DomainList": [
"abdwww.cn"
],
"ReservedStatus": 0,
"ReservedTimeSort": "asc",
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"ReservedPreDomainInfoList": [
{
"Domain": "abdwww.cn",
"ReservedStatus": 0,
"FailReason": "",
"ChangeOwnerTime": "2024-03-01 20:13:23",
"RegTime": "2022-03-01 20:13:23",
"ExpireTime": "2024-03-01 20:13:23",
"ResourceId": "domain-dfo23req"
}
],
"Total": 1,
"RequestId": "xxxx-xxx-xxx-xxxx"
}
}
示例2 请求成功示例
请求成功获取参数示例
输入示例
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReservedPreDomainInfo
<公共请求参数>
{}
输出示例
{
"Response": {
"RequestId": "xxxx-xxx-xxx-xxxx",
"ReservedPreDomainInfoList": [
{
"BusinessId": "P0011712734968570466",
"ChangeOwnerTime": "2024-03-15 08:40:34",
"Domain": "fdasfasfdsaf.com",
"ExpireTime": "2024-01-14 08:40:34",
"FailReason": "",
"RegTime": "2020-01-14 08:40:34",
"ReservedStatus": 6,
"ResourceId": "R0011712734968672830"
}
],
"Total": 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.UinNotWhiteListErr | 用户不再白名单列表,无法调用该接口 |
InternalError.DbError | 数据库报错。 |
InvalidParameterValue.InvalidParameterFormat | 表单参数取值错误。 |