import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; import { DescribeCdnDomainLogsResponse, DescribePushQuotaResponse, DescribePurgeQuotaResponse, DescribeCdnDomainLogsRequest, CreateClsLogTopicResponse, PurgePathCacheResponse, DescribeTopDataRequest, DescribePurgeQuotaRequest, ModifyPurgeFetchTaskStatusRequest, DescribeCdnDataResponse, EnableClsLogTopicRequest, UpdateImageConfigResponse, DescribeCdnOriginIpResponse, DescribePayTypeResponse, ListTopDataRequest, ListClsTopicDomainsRequest, DescribeDomainsResponse, DescribePayTypeRequest, UpdateImageConfigRequest, DescribeBillingDataRequest, DeleteClsLogTopicRequest, DescribeDistrictIspDataResponse, DescribeCdnOriginIpRequest, DescribeDomainsConfigResponse, DescribeReportDataResponse, DisableClsLogTopicRequest, ListClsTopicDomainsResponse, DescribeCdnIpRequest, DescribeHttpsPackagesRequest, DescribeTrafficPackagesRequest, DescribeIpVisitResponse, EnableClsLogTopicResponse, ListClsLogTopicsResponse, AddCdnDomainRequest, UpdateDomainConfigRequest, DescribeCertDomainsRequest, DescribeDomainsConfigRequest, DescribeHttpsPackagesResponse, DescribeCertDomainsResponse, DuplicateDomainConfigRequest, DescribePushTasksResponse, AddCdnDomainResponse, DescribeEdgePackTaskStatusResponse, AddCLSTopicDomainsResponse, ModifyPurgeFetchTaskStatusResponse, DisableClsLogTopicResponse, DescribeIpStatusRequest, DuplicateDomainConfigResponse, VerifyDomainRecordResponse, ManageClsTopicDomainsRequest, AddCLSTopicDomainsRequest, DescribeOriginDataRequest, SearchClsLogResponse, PushUrlsCacheRequest, DescribeReportDataRequest, DescribePushTasksRequest, DescribeUrlViolationsRequest, CreateEdgePackTaskRequest, CreateClsLogTopicRequest, UpdatePayTypeResponse, ListTopClsLogDataRequest, CreateVerifyRecordResponse, StopCdnDomainRequest, DescribeMapInfoResponse, DescribeTrafficPackagesResponse, DescribeMapInfoRequest, PurgeUrlsCacheRequest, DescribeIpVisitRequest, DescribeEdgePackTaskStatusRequest, PurgeUrlsCacheResponse, DeleteClsLogTopicResponse, DescribeBillingDataResponse, DescribeImageConfigRequest, DescribeCdnIpResponse, DescribeIpStatusResponse, DescribeDistrictIspDataRequest, ListTopClsLogDataResponse, ListClsLogTopicsRequest, CreateVerifyRecordRequest, PurgePathCacheRequest, ModifyDomainConfigResponse, StartCdnDomainRequest, DeleteCdnDomainRequest, CreateEdgePackTaskResponse, StartCdnDomainResponse, DescribePushQuotaRequest, DescribePurgeTasksRequest, PushUrlsCacheResponse, ListTopDataResponse, UpdateDomainConfigResponse, SearchClsLogRequest, ManageClsTopicDomainsResponse, ModifyDomainConfigRequest, DescribeUrlViolationsResponse, UpdatePayTypeRequest, DescribePurgeTasksResponse, DescribeOriginDataResponse, DeleteCdnDomainResponse, DescribeCdnDataRequest, DescribeImageConfigResponse, VerifyDomainRecordRequest, DescribeTopDataResponse, DescribeDomainsRequest, StopCdnDomainResponse } from "./cdn_models"; /** * cdn client * @class */ export declare class Client extends AbstractClient { constructor(clientConfig: ClientConfig); /** * AddCLSTopicDomains 用于新增域名到某日志主题下 */ AddCLSTopicDomains(req: AddCLSTopicDomainsRequest, cb?: (error: string, rep: AddCLSTopicDomainsResponse) => void): Promise; /** * 动态打包任务提交接口 */ CreateEdgePackTask(req: CreateEdgePackTaskRequest, cb?: (error: string, rep: CreateEdgePackTaskResponse) => void): Promise; /** * ModifyDomainConfig 用于修改内容分发网络加速域名配置信息 注意: Route 字段,使用点分隔,最后一段称为叶子节点,非叶子节点配置保持不变; Value 字段,使用 json 进行序列化,其中固定 update 作为 key,配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型,为配置路径对应复杂类型下的节点。 操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。 */ ModifyDomainConfig(req: ModifyDomainConfigRequest, cb?: (error: string, rep: ModifyDomainConfigResponse) => void): Promise; /** * DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项:暂不支持查询边缘节点信息并且数据会存在一定延迟。 >? 若您的业务已迁移至 CDN 控制台,请参考 CDN 接口文档,使用 CDN 相关API 进行操作。 */ DescribeIpStatus(req: DescribeIpStatusRequest, cb?: (error: string, rep: DescribeIpStatusResponse) => void): Promise; /** * DescribeMapInfo 用于查询省份对应的 ID,运营商对应的 ID 信息。 */ DescribeMapInfo(req: DescribeMapInfoRequest, cb?: (error: string, rep: DescribeMapInfoResponse) => void): Promise; /** * DeleteCdnDomain 用于删除指定加速域名 */ DeleteCdnDomain(req: DeleteCdnDomainRequest, cb?: (error: string, rep: DeleteCdnDomainResponse) => void): Promise; /** * VerifyDomainRecord 用于验证域名解析值。 验证域名解析记录值前,您需要通过 [CreateVerifyRecord](https://cloud.tencent.com/document/product/228/48118) 生成校验解析值,验证通过后,24小时有效。 具体流程可参考:[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3.95.E4.B8.89.EF.BC.9Aapi-.E6.8E.A5.E5.8F.A3.E6.93.8D.E4.BD.9C) */ VerifyDomainRecord(req: VerifyDomainRecordRequest, cb?: (error: string, rep: VerifyDomainRecordResponse) => void): Promise; /** * DescribeEdgePackTaskStatus 用于查询动态打包任务状态列表 */ DescribeEdgePackTaskStatus(req: DescribeEdgePackTaskStatusRequest, cb?: (error: string, rep: DescribeEdgePackTaskStatusResponse) => void): Promise; /** * DescribePayType 用于查询用户的计费类型,计费周期等信息。 */ DescribePayType(req: DescribePayTypeRequest, cb?: (error: string, rep: DescribePayTypeResponse) => void): Promise; /** * DescribeDomainsConfig 用于查询内容分发网络加速域名(含境内、境外)的所有配置信息。 */ DescribeDomainsConfig(req: DescribeDomainsConfigRequest, cb?: (error: string, rep: DescribeDomainsConfigResponse) => void): Promise; /** * AddCdnDomain 用于新增内容分发网络加速域名。1分钟内最多可新增100个域名。 */ AddCdnDomain(req: AddCdnDomainRequest, cb?: (error: string, rep: AddCdnDomainResponse) => void): Promise; /** * DescribeIpVisit 用于查询 5 分钟活跃用户数,及日活跃用户数明细 + 5 分钟活跃用户数:根据日志中客户端 IP,5 分钟粒度去重统计 + 日活跃用户数:根据日志中客户端 IP,按天粒度去重统计 */ DescribeIpVisit(req: DescribeIpVisitRequest, cb?: (error: string, rep: DescribeIpVisitResponse) => void): Promise; /** * DescribeCdnData 用于查询 CDN 实时访问监控数据,支持以下指标查询: + 流量(单位为 byte) + 带宽(单位为 bps) + 请求数(单位为 次) + 命中请求数(单位为 次) + 请求命中率(单位为 %) + 命中流量(单位为 byte) + 流量命中率(单位为 %) + 状态码 2xx 汇总及各 2 开头状态码明细(单位为 个) + 状态码 3xx 汇总及各 3 开头状态码明细(单位为 个) + 状态码 4xx 汇总及各 4 开头状态码明细(单位为 个) + 状态码 5xx 汇总及各 5 开头状态码明细(单位为 个) */ DescribeCdnData(req: DescribeCdnDataRequest, cb?: (error: string, rep: DescribeCdnDataResponse) => void): Promise; /** * DescribeHttpsPackages 用于查询 CDN HTTPS请求包详情。 */ DescribeHttpsPackages(req: DescribeHttpsPackagesRequest, cb?: (error: string, rep: DescribeHttpsPackagesResponse) => void): Promise; /** * DescribeDomains 用于查询内容分发网络加速域名(含境内、境外)基本配置信息,包括项目ID、服务状态,业务类型、创建时间、更新时间等信息。 */ DescribeDomains(req: DescribeDomainsRequest, cb?: (error: string, rep: DescribeDomainsResponse) => void): Promise; /** * CreateVerifyRecord 用于生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。 生成的解析记录可通过 [VerifyDomainRecord](https://cloud.tencent.com/document/product/228/48117) 完成归属权校验。 注意:生成的解析记录有效期为24小时,超过24小时后,需重新生成。 具体流程可参考:[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3.95.E4.B8.89.EF.BC.9Aapi-.E6.8E.A5.E5.8F.A3.E6.93.8D.E4.BD.9C) */ CreateVerifyRecord(req: CreateVerifyRecordRequest, cb?: (error: string, rep: CreateVerifyRecordResponse) => void): Promise; /** * ManageClsTopicDomains 用于管理某日志主题下绑定的域名列表。 */ ManageClsTopicDomains(req: ManageClsTopicDomainsRequest, cb?: (error: string, rep: ManageClsTopicDomainsResponse) => void): Promise; /** * StartCdnDomain 用于启用已停用域名的加速服务 */ StartCdnDomain(req: StartCdnDomainRequest, cb?: (error: string, rep: StartCdnDomainResponse) => void): Promise; /** * 拷贝参考域名的配置至新域名。暂不支持自有证书以及定制化配置 */ DuplicateDomainConfig(req: DuplicateDomainConfigRequest, cb?: (error: string, rep: DuplicateDomainConfigResponse) => void): Promise; /** * 通过CLS日志计算Top信息。支持近7天的日志数据。 */ ListTopClsLogData(req: ListTopClsLogDataRequest, cb?: (error: string, rep: ListTopClsLogDataResponse) => void): Promise; /** * DescribePurgeQuota 用于查询账户刷新配额和每日可用量。 */ DescribePurgeQuota(req?: DescribePurgeQuotaRequest, cb?: (error: string, rep: DescribePurgeQuotaResponse) => void): Promise; /** * DescribeImageConfig 用于获取域名图片优化的当前配置,支持Webp、TPG、 Guetzli 和 Avif。 */ DescribeImageConfig(req: DescribeImageConfigRequest, cb?: (error: string, rep: DescribeImageConfigResponse) => void): Promise; /** * DescribeTopData 通过入参 Metric 和 Filter 组合不同,可以查询以下排序数据: + 依据总流量、总请求数对访问 IP 排序,从大至小返回 TOP 100 IP + 依据总流量、总请求数对访问 Refer 排序,从大至小返回 TOP 100 Refer + 依据总流量、总请求数对访问 设备 排序,从大至小返回 设备类型 + 依据总流量、总请求数对访问 操作系统 排序,从大至小返回 操作系统 + 依据总流量、总请求数对访问 浏览器 排序,从大至小返回 浏览器 注意: + 仅支持 90 天内数据查询,且从2021年09月20日开始有数据 */ DescribeTopData(req: DescribeTopDataRequest, cb?: (error: string, rep: DescribeTopDataResponse) => void): Promise; /** * SearchClsLog 用于 CLS 日志检索。支持检索今天,24小时(可选近7中的某一天),近7天的日志数据。 */ SearchClsLog(req: SearchClsLogRequest, cb?: (error: string, rep: SearchClsLogResponse) => void): Promise; /** * StopCdnDomain 用于停止域名的加速服务。 注意:停止加速服务后,访问至加速节点的请求将会直接返回 404。为避免对您的业务造成影响,请在停止加速服务前将解析切走。 */ StopCdnDomain(req: StopCdnDomainRequest, cb?: (error: string, rep: StopCdnDomainResponse) => void): Promise; /** * ListTopData 通过入参 Metric 和 Filter 组合不同,可以查询以下排序数据: + 依据总流量、总请求数对访问 URL 排序,从大至小返回 TOP 1000 URL + 依据总流量、总请求数对客户端省份排序,从大至小返回省份列表 + 依据总流量、总请求数对客户端运营商排序,从大至小返回运营商列表 + 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序,从大至小返回域名列表 + 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序,从大至小返回域名列表 注意:仅支持 90 天内数据查询 */ ListTopData(req: ListTopDataRequest, cb?: (error: string, rep: ListTopDataResponse) => void): Promise; /** * DescribeOriginData 用于查询 CDN 实时回源监控数据,支持以下指标查询: + 回源流量(单位为 byte) + 回源带宽(单位为 bps) + 回源请求数(单位为 次) + 回源失败请求数(单位为 次) + 回源失败率(单位为 %,小数点后保留两位) + 回源状态码 2xx 汇总及各 2 开头回源状态码明细(单位为 个) + 回源状态码 3xx 汇总及各 3 开头回源状态码明细(单位为 个) + 回源状态码 4xx 汇总及各 4 开头回源状态码明细(单位为 个) + 回源状态码 5xx 汇总及各 5 开头回源状态码明细(单位为 个) */ DescribeOriginData(req: DescribeOriginDataRequest, cb?: (error: string, rep: DescribeOriginDataResponse) => void): Promise; /** * DescribeCdnIp 用于查询 CDN IP 归属。 (注意:此接口请求频率限制以 CDN 侧限制为准:200次/10分钟) */ DescribeCdnIp(req: DescribeCdnIpRequest, cb?: (error: string, rep: DescribeCdnIpResponse) => void): Promise; /** * PurgePathCache 用于批量提交目录刷新,根据域名的加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日目录刷新额度为各 100 条,每次最多可提交 500 条。 */ PurgePathCache(req: PurgePathCacheRequest, cb?: (error: string, rep: PurgePathCacheResponse) => void): Promise; /** * DescribePurgeTasks 用于查询提交的 URL 刷新、目录刷新记录及执行进度,通过 PurgePathCache 与 PurgeUrlsCache 接口提交的任务均可通过此接口进行查询。 */ DescribePurgeTasks(req: DescribePurgeTasksRequest, cb?: (error: string, rep: DescribePurgeTasksResponse) => void): Promise; /** * DescribeUrlViolations 用于查询被 CDN 系统扫描到的域名违规 URL 列表及当前状态。 对应内容分发网络控制台【内容合规】页面。 */ DescribeUrlViolations(req: DescribeUrlViolationsRequest, cb?: (error: string, rep: DescribeUrlViolationsResponse) => void): Promise; /** * PurgeUrlsCache 用于批量提交 URL 进行刷新,根据 URL 中域名的当前加速区域进行对应区域的刷新。 默认情况下境内、境外加速区域每日 URL 刷新额度各为 10000 条,每次最多可提交 1000 条。 */ PurgeUrlsCache(req: PurgeUrlsCacheRequest, cb?: (error: string, rep: PurgeUrlsCacheResponse) => void): Promise; /** * DescribeTrafficPackages 用于查询 CDN 流量包详情。 */ DescribeTrafficPackages(req: DescribeTrafficPackagesRequest, cb?: (error: string, rep: DescribeTrafficPackagesResponse) => void): Promise; /** * UpdateDomainConfig 用于修改内容分发网络加速域名配置信息。 注意:如果需要更新复杂类型的配置项,必须传递整个对象的所有属性,未传递的属性将使用默认值,建议通过查询接口获取配置属性后,直接修改后传递给本接口;如果仅修改单独配置项只传对应配置参数即可。 操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。 */ UpdateDomainConfig(req: UpdateDomainConfigRequest, cb?: (error: string, rep: UpdateDomainConfigResponse) => void): Promise; /** * DescribeCdnDomainLogs 用于查询访问日志下载地址,仅支持 30 天以内的境内、境外访问日志下载链接查询。 */ DescribeCdnDomainLogs(req: DescribeCdnDomainLogsRequest, cb?: (error: string, rep: DescribeCdnDomainLogsResponse) => void): Promise; /** * DescribePushTasks 用于查询预热任务提交历史记录及执行进度。 */ DescribePushTasks(req: DescribePushTasksRequest, cb?: (error: string, rep: DescribePushTasksResponse) => void): Promise; /** * DescribeCertDomains 用于校验SSL证书并提取证书中包含的域名。 */ DescribeCertDomains(req: DescribeCertDomainsRequest, cb?: (error: string, rep: DescribeCertDomainsResponse) => void): Promise; /** * CreateClsLogTopic 用于创建日志主题。注意:一个日志集下至多可创建10个日志主题。 */ CreateClsLogTopic(req: CreateClsLogTopicRequest, cb?: (error: string, rep: CreateClsLogTopicResponse) => void): Promise; /** * PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点,支持指定加速区域预热。 默认情况下境内、境外每日预热 URL 限额为各 1000 条,每次最多可提交 500 条 URL,每次提交的数量会消耗配额总数。如:1次提交500条URL全球预热,此时境内、境外预热 URL 各剩余 500条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点。 */ PushUrlsCache(req: PushUrlsCacheRequest, cb?: (error: string, rep: PushUrlsCacheResponse) => void): Promise; /** * UpdateImageConfig 用于更新控制台图片优化的相关配置,支持Webp、TPG、 Guetzli 和 Avif。 */ UpdateImageConfig(req: UpdateImageConfigRequest, cb?: (error: string, rep: UpdateImageConfigResponse) => void): Promise; /** * ModifyPurgeFetchTaskStatus 用于上报定时刷新预热任务执行状态 */ ModifyPurgeFetchTaskStatus(req: ModifyPurgeFetchTaskStatusRequest, cb?: (error: string, rep: ModifyPurgeFetchTaskStatusResponse) => void): Promise; /** * DisableClsLogTopic 用于停止日志主题投递。注意:停止后,所有绑定该日志主题域名的日志将不再继续投递至该主题,已经投递的日志将会继续保留。生效时间约为 5~15 分钟。 */ DisableClsLogTopic(req: DisableClsLogTopicRequest, cb?: (error: string, rep: DisableClsLogTopicResponse) => void): Promise; /** * ListClsTopicDomains 用于获取某日志主题下绑定的域名列表。 */ ListClsTopicDomains(req: ListClsTopicDomainsRequest, cb?: (error: string, rep: ListClsTopicDomainsResponse) => void): Promise; /** * ListClsLogTopics 用于显示日志主题列表。注意:一个日志集下至多含10个日志主题。 */ ListClsLogTopics(req: ListClsLogTopicsRequest, cb?: (error: string, rep: ListClsLogTopicsResponse) => void): Promise; /** * DeleteClsLogTopic 用于删除日志主题。注意:删除后,所有该日志主题下绑定域名的日志将不再继续投递至该主题,已经投递的日志将会被全部清空。生效时间约为 5~15 分钟。 */ DeleteClsLogTopic(req: DeleteClsLogTopicRequest, cb?: (error: string, rep: DeleteClsLogTopicResponse) => void): Promise; /** * ### **该接口已废弃**
本接口(DescribeCdnOriginIp)用于查询 CDN 回源节点的IP信息。(注:替换接口为DescribeIpStatus) */ DescribeCdnOriginIp(req?: DescribeCdnOriginIpRequest, cb?: (error: string, rep: DescribeCdnOriginIpResponse) => void): Promise; /** * DescribeBillingData 用于查询实际计费数据明细。 注意: 受计费算法的影响,计费数据接口返回的数据均存在一定延时。小时结算客户预计延时3-5小时。月结算客户预计延迟4-28小时,在凌晨4点(不含4点)之前,仅能查询到前2天数据,4点(含)之后,能查询到前1天数据。若您对数据及时性较强的诉求,建议使用[监控访问数据](https://cloud.tencent.com/document/product/228/30986)。 */ DescribeBillingData(req: DescribeBillingDataRequest, cb?: (error: string, rep: DescribeBillingDataResponse) => void): Promise; /** * DescribePushQuota 用于查询预热配额和每日可用量。 */ DescribePushQuota(req?: DescribePushQuotaRequest, cb?: (error: string, rep: DescribePushQuotaResponse) => void): Promise; /** * EnableClsLogTopic 用于启动日志主题投递。注意:启动后,所有绑定该日志主题域名的日志将继续投递至该主题。生效时间约为 5~15 分钟。 */ EnableClsLogTopic(req: EnableClsLogTopicRequest, cb?: (error: string, rep: EnableClsLogTopicResponse) => void): Promise; /** * DescribeReportData 用于查询域名/项目维度的日/周/月报表数据。 */ DescribeReportData(req: DescribeReportDataRequest, cb?: (error: string, rep: DescribeReportDataResponse) => void): Promise; /** * 查询指定域名的区域、运营商明细数据 注意事项:接口尚未全面开放,未在内测名单中的账号不支持调用 */ DescribeDistrictIspData(req: DescribeDistrictIspDataRequest, cb?: (error: string, rep: DescribeDistrictIspDataResponse) => void): Promise; /** * 本接口(UpdatePayType)用于修改账号计费类型,暂不支持月结用户或子账号修改。 */ UpdatePayType(req: UpdatePayTypeRequest, cb?: (error: string, rep: UpdatePayTypeResponse) => void): Promise; }