有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

查询站点的验证信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIdentifications。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
Filters.N Array of Filter 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:
  • zone-name:按照站点名称进行过滤。
  • Offset Integer 分页查询偏移量。默认值:0。
    Limit Integer 分页查询限制数目。默认值:20,最大值:1000。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的站点个数。
    Identifications Array of Identification 站点验证信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询站点的验证状态

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeIdentifications
    <公共请求参数>
    
    {
        "Limit": 20,
        "Filters": [
            {
                "Values": [
                    "example.com"
                ],
                "Name": "zone-name"
            }
        ],
        "Offset": 0
    }

    输出示例

    {
        "Response": {
            "Identifications": [
                {
                    "ZoneName": "example.com",
                    "Status": "pending",
                    "Ascription": {
                        "Subdomain": "edgeonereclaim",
                        "RecordType": "TXT",
                        "RecordValue": "reclaim-a24aba2420cf4ce8b7bff7c8be6d337f"
                    },
                    "OriginalNameServers": [
                        "ns1.example.com",
                        "ns2.example.com"
                    ],
                    "FileAscription": {
                        "IdentifyContent": "88v24mnnljwbhaohrpfx80f63duhdnjx",
                        "IdentifyPath": "/.well-known/teo-verification/vd4ewuqa9n.txt"
                    }
                }
            ],
            "TotalCount": 1,
            "RequestId": "8gs50b24-7df5-47f4-96ae-95825d53er3c"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    OperationDenied.DomainInShareCnameGroup 有域名在共享cname组内,不可切换接入类型。
    OperationDenied.ErrZoneIsAlreadyPaused 站点处于停用状态,请开启后重试。
    OperationDenied.ResourceLockedTemporary 当前有互相排斥的请求操作并行发起,请稍后重试。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。