文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>边缘安全加速平台 EO>API 文档>加速域名管理相关接口>查询共享CNAME列表

查询共享CNAME列表

最近更新时间：2026-04-03 02:20:25

我的收藏

本页目录：

1. 接口描述

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

查询共享CNAME列表，支持模糊搜索、分页、排序等。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSharedCNAME。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 是 String 共享CNAME所属站点ID。
Filters.N 否 Array of AdvancedFilter 过滤条件，Filters.Values的上限为20。详细的过滤条件如下：
  • shared-cname
       按照【共享CNAME】进行过滤。
       类型：String
       必选：否
  • type
       按照【共享canme类型】进行过滤。
       类型：String
       必选：否
  • description
       按照【描述】进行过滤。
       类型：String
       必选：否
    		•
    Direction 否 String 列表排序方式，取值有：
  • asc：升序排列；
  • desc：降序排列。
    • 默认值为asc。
    Match 否 String 匹配方式，取值有：
  • all：返回匹配所有查询条件的共享CNAME；
  • any：返回匹配任意一个查询条件的共享CNAME。
    • 默认值为all。
    Order 否 String 排序依据，取值有：
  • create-time：创建时间；
  • shared-cname：共享CNAME；
    • 默认根据shared-cname属性排序。
    Offset 否 Integer 分页查询偏移量，默认为 0。
    Limit 否 Integer 分页查询限制数目，默认值：20，上限：200。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的共享CNAME总数。
    SharedCNAMEInfo Array of SharedCNAMEInfo 共享CNAME列表明细。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询共享CNAME列表

    查询共享CNAME列表

    输入示例

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

{
    "Direction": "desc",
    "ZoneId": "zone-20hyebgyfsko",
    "Limit": 10,
    "Filters": [
        {
            "Fuzzy": true,
            "Values": [
                "qq.com"
            ],
            "Name": "shared-cname"
        }
    ],
    "Offset": 0,
    "Order": "create-time",
    "Match": "all"
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "SharedCNAMEInfo": [
            {
                "SharedCNAME": "qq.com.share.eo.dnse5.com",
                "Description": "用于业务A场景",
                "BindDomainCount": 3
            }
        ]
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。
    中国站