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

1. 接口描述

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

您可以通过本接口查看站点下的域名信息,包括加速域名、源站以及域名状态等信息。您可以查看站点下全部域名的信息,也可以指定过滤条件查询对应的域名信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccelerationDomains。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 加速域名所属站点 ID。
Offset Integer 分页查询偏移量,默认为 0。
Limit Integer 分页查询限制数目,默认值:20,上限:200。
Filters.N Array of AdvancedFilter 过滤条件,Filters.Values 的上限为 20。该参数不填写时,返回当前 zone-id 下所有域名信息。详细的过滤条件如下:
  • domain-name:按照加速域名进行过滤;
  • origin-type:按照源站类型进行过滤;
  • origin:按照主源站地址进行过滤;
  • backup-origin: 按照备用源站地址进行过滤;
  • domain-cname:按照 CNAME 进行过滤;
  • share-cname:按照共享 CNAME 进行过滤;
  • vodeo-sub-app-id:按照【 vodeo 子应用 ID】进行过滤;
  • vodeo-distribution-range:按照【 vodeo 分发范围】进行过滤;
  • vodeo-bucket-id:按照【vodeo 存储桶 ID】进行过滤;
  • Order String 可根据该字段对返回结果进行排序,取值有:
  • created_on:加速域名创建时间;
  • domain-name:加速域名。
  • 不填写时,默认对返回结果按照 domain-name 排序。
    Direction String 排序方向,如果是字段值为数字,则根据数字大小排序;如果字段值为文本,则根据 ascill 码的大小排序。取值有:
  • asc:升序排列;
  • desc:降序排列。
  • 不填写使用默认值 asc。
    Match String 匹配方式,取值有:
  • all:返回匹配所有查询条件的加速域名;
  • any:返回匹配任意一个查询条件的加速域名。
  • 不填写时默认值为 all。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合查询条件的加速域名个数。
    AccelerationDomains Array of AccelerationDomain 符合查询条件的所有加速域名的信息。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询指定站点下的域名信息

    查询指定 zone-id 的下的源站类型为 IP_DOMAIN 的所有加速域名的信息,并将结果按照创建时间降序排列。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAccelerationDomains
    <公共请求参数>
    
    {
        "ZoneId": "zone-20hyebgyfsko",
        "Filters": [
            {
                "Fuzzy": true,
                "Values": [
                    "IP_DOMAIN"
                ],
                "Name": "origin-type"
            }
        ],
        "Direction": "desc",
        "Order": "created_on",
        "Match": "all"
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "AccelerationDomains": [
                {
                    "ZoneId": "zone-20hyebgyfsko",
                    "DomainName": "www.qq.com",
                    "DomainStatus": "online",
                    "OriginDetail": {
                        "OriginType": "IP_DOMAIN",
                        "Origin": "origin.qq.com",
                        "BackupOrigin": "",
                        "PrivateParameters": [],
                        "PrivateAccess": "",
                        "OriginGroupName": "",
                        "BackOriginGroupName": ""
                    },
                    "IdentificationStatus": "finished",
                    "Cname": "www.qq.com.eo.dnse3.com",
                    "CreatedOn": "2020-09-22T00:00:00+00:00",
                    "ModifiedOn": "2020-09-22T00:00:00+00:00"
                }
            ],
            "RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError.ProxyServer 后端服务器发生未知错误。
    InvalidParameter.DomainOnTrafficScheduling 当前域名已开启流量调度功能。
    InvalidParameter.TooManyFilterValues 过滤值过多。
    OperationDenied 操作被拒绝。
    ResourceNotFound 资源不存在。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。