帮你快速理解、总结文档立即下载

搜索域名

最近更新时间:2025-09-12 03:28:38
我的收藏

1. 接口描述

接口请求域名: sslpod.tencentcloudapi.com 。

通过searchType搜索已经添加的域名

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeDomains。
Version 是 String 公共参数,本接口取值:2019-06-05。
Region 否 String 公共参数,本接口不需要传递此参数。
Offset 是 Integer 偏移量
示例值:0
Limit 是 Integer 获取数量
示例值:1000
SearchType 是 String 搜索的类型有:none,tags,grade,brand,code,hash,limit,domain。
选tags,入参请填Tag,
选grade,入参请填Grade,
选brand,入参请填Brand,
选code,入参请填Code,
选hash,入参请填Hash
选limit,标识只返回数量信息
选domain,入参请填Domain
示例值:none
Tag 否 String 标签,多个标签用逗号分隔
Grade 否 String 等级
Brand 否 String 品牌
Code 否 String 混合搜索
Hash 否 String 证书指纹
Item 否 String 搜索图标类型
Status 否 String 搜索图标值
Domain 否 String 搜索域名

3. 输出参数

参数名称 类型 描述
Data DescribeDomains 列表数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 搜索已经添加的域名

输入示例

POST / HTTP/1.1
Host: sslpod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomains
<公共请求参数>

{
    "Offset": 0,
    "Limit": 1000,
    "SearchType": "none",
    "Tag": "",
    "Grade": "",
    "Brand": "",
    "Code": "",
    "Hash": ""
}

输出示例

{
    "Response": {
        "Data": {
            "SearchTotal": 3,
            "Total": 3,
            "Result": [
                {
                    "Id": 13079,
                    "Domain": "cloud.tencent.com",
                    "Ip": "1.1.1.1",
                    "AutoIP": true,
                    "Port": "443",
                    "ServerType": 0,
                    "Brand": "xxxxx",
                    "Status": "正常",
                    "Grade": "",
                    "GradeCode": 0,
                    "Notice": false,
                    "AccountDomainId": 15072,
                    "Tags": [
                        "123"
                    ]
                },
                {
                    "Id": 13078,
                    "Domain": "1.qcloud.com",
                    "Ip": "2.2.2.2",
                    "AutoIP": true,
                    "Port": "80",
                    "ServerType": 0,
                    "Brand": "",
                    "Status": "连接异常",
                    "Grade": "",
                    "GradeCode": 0,
                    "Notice": false,
                    "AccountDomainId": 15071,
                    "Tags": [
                        "123"
                    ]
                },
                {
                    "Id": 13077,
                    "Domain": "2.qcloud.com",
                    "Ip": "3.3.3.3",
                    "AutoIP": true,
                    "Port": "80",
                    "ServerType": 0,
                    "Brand": "",
                    "Status": "连接异常",
                    "Grade": "",
                    "GradeCode": 0,
                    "Notice": false,
                    "AccountDomainId": 15070,
                    "Tags": [
                        "123"
                    ]
                }
            ],
            "AllowMonitoringCount": 3,
            "CurrentMonitoringCount": 0,
            "AllowMaxAddDomain": 20
        },
        "RequestId": "b106abc5-de9e-48ea-b95b-871ac898edd7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter.InvalidDomain 无效的域名。
InvalidParameterValue.InvalidSearchType 无效的搜索类型。