查询域名详细配置

最近更新时间:2024-03-12 01:28:49

我的收藏

1. 接口描述

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

本接口(DescribeDomainsConfig)用于查询CDN加速域名详细配置信息。

说明:

若您的业务已迁移至 CDN 控制台,请参考 CDN 接口文档,使用 CDN 相关API 进行操作。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDomainsConfig。
Version String 公共参数,本接口取值:2019-10-12。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页查询的偏移地址,默认0。
示例值:0
Limit Integer 分页查询的域名个数,默认100。
示例值:10
Filters.N Array of DomainFilter 查询条件过滤器。
Sort Sort 查询结果排序规则。

3. 输出参数

参数名称 类型 描述
Domains Array of DomainDetailInfo 域名列表。
TotalCount Integer 符合查询条件的域名总数,用于分页查询。
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询域名详细配置

输入示例

https://ecdn.tencentcloudapi.com/?Action=DescribeDomainsConfig
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "932fe708-0ce1-46ec-b403-bcd8bdb08fdd",
        "Domains": [
            {
                "AppId": 1251000000,
                "Area": "mainland",
                "Cache": {
                    "CacheRules": [
                        {
                            "CacheType": "all",
                            "CacheContents": [
                                "*"
                            ],
                            "CacheTime": 0
                        },
                        {
                            "CacheType": "file",
                            "CacheContents": [
                                "gif",
                                "png",
                                "bmp",
                                "jpg",
                                "jpeg",
                                "mp3",
                                "wma",
                                "flv",
                                "mp4",
                                "wmv",
                                "avi",
                                "m3u8",
                                "ts"
                            ],
                            "CacheTime": 86400
                        },
                        {
                            "CacheType": "file",
                            "CacheContents": [
                                "doc",
                                "docx",
                                "xls",
                                "xlsx",
                                "ppt",
                                "pptx",
                                "txt",
                                "pdf"
                            ],
                            "CacheTime": 86400
                        },
                        {
                            "CacheType": "file",
                            "CacheContents": [
                                "exe",
                                "apk",
                                "ipa",
                                "rar",
                                "zip",
                                "7z",
                                "css",
                                "js",
                                "xml",
                                "ini",
                                "swf",
                                "ico"
                            ],
                            "CacheTime": 86400
                        }
                    ]
                },
                "CacheKey": {
                    "FullUrlCache": "on"
                },
                "Cname": "test.com.com.dsa.dnsv1.com",
                "CreateTime": "2019-12-03 15:23:50",
                "Disable": "normal",
                "Domain": "test.com",
                "ForceRedirect": null,
                "Https": {
                    "Switch": "off",
                    "Http2": "off",
                    "Spdy": "off",
                    "OcspStapling": "off",
                    "VerifyClient": "off",
                    "CertInfo": null,
                    "ClientCertInfo": null,
                    "SslStatus": "closed"
                },
                "IpFilter": {
                    "Switch": "off",
                    "FilterType": "blacklist",
                    "Filters": []
                },
                "IpFreqLimit": {
                    "Switch": "off",
                    "Qps": null
                },
                "Origin": {
                    "Origins": [
                        "1.1.1.1"
                    ],
                    "OriginType": "ip",
                    "ServerName": null,
                    "OriginPullProtocol": "http",
                    "BackupOrigins": [],
                    "BackupOriginType": null
                },
                "ProjectId": 0,
                "Readonly": "normal",
                "ResourceId": "ecdn-xxxxxx",
                "ResponseHeader": {
                    "HeaderRules": [],
                    "Switch": "off"
                },
                "Status": "processing",
                "UpdateTime": "2019-12-03 15:23:50",
                "Tag": [],
                "WebSocket": null
            }
        ],
        "TotalCount": 10
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.EcdnConfigError 域名配置更新操作失败,请重试或联系客服人员解决。
InternalError.CamSystemError CAM鉴权错误,请稍后重试。
InternalError.EcdnConfigError 内部配置服务错误,请重试或联系客服人员解决。
InternalError.EcdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.EcdnQuerySystemError 系统内部错误,请联系客户人员解决或稍后重试。
InternalError.EcdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误,请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnCertNoCertInfo 无法解析证书信息。
InvalidParameter.EcdnConfigInvalidCache 缓存配置不合法 。
InvalidParameter.EcdnInterfaceError 内部接口错误,请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnParamError 参数错误,请参考文档中示例参数填充。
LimitExceeded.EcdnDomainOpTooOften 域名操作过于频繁。
ResourceNotFound.EcdnDomainNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.EcdnUserNotExists 未开通ECDN服务,请开通后使用此接口。
UnauthorizedOperation.EcdnCamUnauthorized 子账号未配置cam策略。