华为云用户手册

  • 响应示例 状态码: 200 成功响应 设置用户计费模式 { "charge_mode" : "flux", "effective_time" : 1666238400000, "create_time" : 1664596800000, "service_area" : "mainland_china", "status" : "active", "product_type" : "base" }
  • 响应示例 状态码: 200 OK { "quotas" : [ { "quota_limit" : 2000, "type" : "file_refresh", "used" : 0, "user_domain_id" : "0b672************************ae0" }, { "quota_limit" : 2000, "type" : "dir_refresh", "used" : 0, "user_domain_id" : "0b672************************ae0" }, { "quota_limit" : 1000, "type" : "preheat", "used" : 0, "user_domain_id" : "0b672************************ae0" }, { "quota_limit" : 100, "type" : "domain", "used" : 4, "user_domain_id" : "0b672************************ae0" } ] }
  • 响应示例 状态码: 200 成功响应 查询用户计费模式 { "result" : { "charge_mode" : "flux", "effective_time" : 1666238400000, "service_area" : "mainland_china", "status" : "active", "product_type" : "base" } }
  • URI GET /v1.0/cdn/charge/charge-modes 表1 Query参数 参数 是否必选 参数类型 描述 product_type 是 String 加速类型,base(基础加速) status 否 String 查询计费模式状态,active(已生效),upcoming(待生效),不传默认为active(已生效) service_area 否 String 服务区域,mainland_china(国内),outside_mainland_china(海外),不传默认为mainland_china(国内)
  • URI GET /v1.0/cdn/statistics/top-refers 表1 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询起始时间戳,需与结束时间戳同时指定,左闭右开,设置方式如下: interval为300时,start_time设置为整5分钟时刻点,如:1631240100000(对应2021-09-10 10:15:00) interval为3600时,start_time设置为整小时时刻点,如:1631239200000(对应2021-09-10 10:00:00) interval为86400时,start_time设置为东8区零点时刻点,如:1631203200000(对应2021-09-10 00:00:00) end_time 是 Long 查询结束时间戳,需与开始时间戳同时指定,左闭右开,设置方式如下: interval为300时,end_time设置为整5分钟时刻点,如:1631243700000(对应2021-09-10 11:15:00) interval为3600时,end_time设置为整小时时刻点,如:1631325600000(对应2021-09-11 10:00:00) interval为86400时,end_time设置为东8区零点时刻点,如:1631376000000(对应2021-09-12 00:00:00) domain_name 是 String 域名 列表, 多个域名 以逗号(半角)分隔,如:www.test1.com,www.test2.com all表示查询名下全部域名。如果域名在查询时间段内无数据,结果将不返回该域名的信息。 stat_type 是 String 统计指标类型 目前只支持flux(流量),req_num(请求数) service_area 否 String 服务区域:mainland_china(大陆),outside_mainland_china(海外),默认为global(全球) enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 include_ratio 否 Boolean 是否包含百分比数据,默认false
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 top_refer_summary Array of TopReferSummary objects 详情数据对象。 表3 TopReferSummary 参数 参数类型 描述 refer String referer值。 value Long 对应查询类型的值。(流量单位:Byte) ratio Double 该referer的流量(或请求数)占当前查询条件下总流量(或请求数)的比例。保留4位小数 状态码: default 表4 响应Body参数 参数 参数类型 描述 error ErrMsg object 用于返回具体的错误码和错误消息 表5 ErrMsg 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 正常响应 查询统计top100 referer请求数明细 { "top_refer_summary" : [ { "refer" : "www.test1.com", "value" : 1000, "ratio" : 0.1 }, { "refer" : "www.test2.com", "value" : 2000, "ratio" : 0.2 } ] } 查询统计top100 referer流量明细 { "top_refer_summary" : [ { "refer" : "www.test1.com", "value" : 50, "ratio" : 0.2 }, { "refer" : "www.test2.com", "value" : 100, "ratio" : 0.4 } ] }
  • 请求示例 查询统计top100 referer请求数明细 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-refers?&start_time=1667030400000&end_time=1667116800000&domain_name=all&stat_type=req_num&service_area=mainland_china&enterprise_project_id=all 查询统计top100 referer流量明细 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-refers?&start_time=1667030400000&end_time=1667116800000&domain_name=all&stat_type=flux&service_area=mainland_china&enterprise_project_id=all
  • 响应示例 状态码: 200 正常响应 不分组详情数据 { "result" : { "503" : [ 1000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ], "504" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1000 ] } } 根据域名分组详情数据 { "result" : { "www.test1.com" : { "200" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ], "206" : [ 115, 113, 125, 102, 132, 95, 133, 105, 117, 109, 128, 109 ] }, "www.test2.com" : { "200" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ], "206" : [ 115, 113, 125, 102, 132, 95, 133, 105, 117, 109, 128, 109 ] } } }
  • 请求示例 不分组详情数据 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-stats?action=summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&service_area=mainland_china&enterprise_project_id=all 按域名分组详情数据 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-stats?action=summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&group_by=domain&service_area=mainland_china&enterprise_project_id=all
  • 功能介绍 支持查询90天内的数据。 支持多指标同时查询,不超过5个。 最多同时指定20个域名。 起始时间和结束时间需要同时指定,左闭右开,毫秒级时间戳,且时间点必须为与查询时间间隔参数匹配的整时刻点。比如查询时间间隔为5分钟时,起始时间和结束时间必须为5分钟整时刻点,如:0分、5分、10分、15分等,如果时间点与时间间隔不匹配,返回数据可能与预期不一致。统一用开始时间表示一个时间段,如:2019-01-24 20:15:00 表示取 [20:15:00, 20:20:00)的统计数据,且左闭右开。 action取值:detail,summary 流量类指标单位统一为Byte(字节)、带宽类指标单位统一为bit/s(比特/秒)、请求数类和状态码类指标单位统一为次数。用于查询指定域名、指定统计指标的明细数据。 单租户调用频率:15次/s。
  • URI GET /v1.0/cdn/statistics/domain-stats 表1 Query参数 参数 是否必选 参数类型 描述 action 是 String 动作名称,可选summary、detail。 summary:查询汇总数据 detail:查询数据详情。 start_time 是 Long 查询起始时间戳,需与结束时间戳同时指定,左闭右开,设置方式如下: interval为300时,start_time设置为整5分钟时刻点,如:1631240100000(对应2021-09-10 10:15:00) interval为3600时,start_time设置为整小时时刻点,如:1631239200000(对应2021-09-10 10:00:00) interval为86400时,start_time设置为东8区零点时刻点,如:1631203200000(对应2021-09-10 00:00:00) end_time 是 Long 查询结束时间戳,需与开始时间戳同时指定,左闭右开,设置方式如下: interval为300时,end_time设置为整5分钟时刻点,如:1631243700000(对应2021-09-10 11:15:00) interval为3600时,end_time设置为整小时时刻点,如:1631325600000(对应2021-09-11 10:00:00) interval为86400时,end_time设置为东8区零点时刻点,如:1631376000000(对应2021-09-12 00:00:00) domain_name 是 String 域名列表,多个域名以逗号(半角)分隔,如:www.test1.com,www.test2.com all表示查询名下全部域名。如果域名在查询时间段内无数据,结果将不返回该域名的信息。 stat_type 是 String 网络资源消耗: bw(带宽) flux(流量) bs_bw(回源带宽) bs_flux(回源流量) 访问情况 req_num(请求总数) hit_num(请求命中次数) bs_num(回源总数) bs_fail_num(回源失败数) hit_flux(命中流量) HTTP状态码(组合指标) http_code_2xx(状态码汇总2xx) http_code_3xx(状态码汇总3xx) http_code_4xx(状态码汇总4xx) http_code_5xx(状态码汇总5xx) bs_http_code_2xx(回源状态码汇总2xx) bs_http_code_3xx(回源状态码汇总3xx) bs_http_code_4xx(回源状态码汇总4xx) bs_http_code_5xx(回源状态码汇总5xx) status_code_2xx(状态码详情2xx) status_code_3xx(状态码详情3xx) status_code_4xx(状态码详情4xx) status_code_5xx(状态码详情5xx) bs_status_code_2xx(回源状态码详情2xx) bs_status_code_3xx(回源状态码详情3xx) bs_status_code_4xx(回源状态码详情4xx) bs_status_code_5xx(回源状态码详情5xx) status_code和bs_status_code不能一起查询 interval 否 Long 查询时间间隔,单位:秒,取值说明: 300(5分钟):最大查询跨度2天 3600(1小时):最大查询跨度7天 86400(1天):最大查询跨度31天 如果不传,默认取对应时间跨度的最小间隔。 group_by 否 String 数据分组方式,可选domain,默认不分组 service_area 否 String 服务区域:mainland_china(默认)、outside_mainland_china,当查询回源类指标时该参数无效。 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。
  • 响应示例 状态码: 200 请求成功 { "dns_verify_type" : "TXT", "dns_verify_name" : "cdn_verification", "file_verify_url" : "http://example.com/verification.html", "verify_domain_name" : "example.com", "domain_name" : "image.example.com", "file_verify_domains" : [ "example.com", "image.example.com" ], "file_verify_filename" : "verification.html", "verify_content" : "202************9e36" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 dns_verify_type String DNS解析类型。 dns_verify_name String DNS解析主机记录名称。 file_verify_url String 文件校验URL地址。 domain_name String 加速域名。 verify_domain_name String 校验域名。 file_verify_filename String 文件校验的校验文件名。 verify_content String 校验值,解析值或者文件内容。 file_verify_domains Array of strings 文件校验域名列表。
  • 响应示例 状态码: 200 成功。 { "result" : [ { "reason" : "This operation is not supported for the domain name in the current state.", "domain_name" : "www.target1.com", "status" : "fail" }, { "reason" : "This operation is not supported for the domain name in the current state.", "domain_name" : "www.target2.com", "status" : "fail" } ] }
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 configs 是 BatchCopyConfigs object 需要复制的原域名配置。 表2 BatchCopyConfigs 参数 是否必选 参数类型 描述 target_domain 是 String 目标域名列表,多个域名以逗号(半角)分隔,域名数最大10个。 source_domain 是 String 原域名 config_list 是 Array of strings 需要复制的域名配置项,多个配置项以逗号(半角)分隔,支持复制的配置项: originRequestHeader(回源请求头) httpResponseHeader(HTTP header配置) cacheUrlParamsConfig(URL参数) urlAuth(URL鉴权配置) userAgentBlackAndWhiteList(User-Agent黑白名单) ipv6Accelerate(IPv6开关) rangeStatus(Range回源) cacheRules(缓存规则) followOrigin(缓存遵循源站) privateBucketRetrieval(私有桶回源) follow302Status(回源跟随) sources(源站配置) compress(智能压缩) referer(防盗链) ipBlackAndWhiteList(IP黑白名单)
  • 请求示例 POST https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/batch-copy { "configs" : { "target_domain" : "www.target1.com,www.target2.com", "source_domain" : "www.source.com", "config_list" : [ "ipv6Accelerate", "follow302Status", "sources" ] } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Array of BatchCopyResultVo objects 复制配置结果。 表4 BatchCopyResultVo 参数 参数类型 描述 reason String 失败原因,成功时没有该字段 status String 批量操作结果。 domain_name String 域名。 状态码: default 表5 响应Body参数 参数 参数类型 描述 error error object 错误体 表6 error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 service_area String 服务区域 top_url_summary Array of TopUrlSummary objects 详情数据对象。 表3 TopUrlSummary 参数 参数类型 描述 url String URL名称。 value Long 对应查询类型的值。(流量单位:Byte) start_time Long 查询起始时间戳。 end_time Long 查询结束时间戳 stat_type String 参数类型支持:flux(流量),req_num(请求总数)。 状态码: default 表4 响应Body参数 参数 参数类型 描述 error ErrMsg object 用于返回具体的错误码和错误消息 表5 ErrMsg 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 正常响应 查询TOP100 URL访问次数明细 { "top_url_summary" : [ { "url" : "www.test1.com", "value" : 888, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "req_num" }, { "url" : "www.test2.com", "value" : 666, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "req_num" } ], "service_area" : "mainland" } 查询TOP100 URL流量明细 { "top_url_summary" : [ { "url" : "www.test1.com", "value" : 1024, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "flux" }, { "url" : "www.test2.com", "value" : 1024, "start_time" : 1667030400000, "end_time" : 1667116800000, "stat_type" : "flux" } ], "service_area" : "mainland" }
  • URI GET /v1.0/cdn/statistics/top-url 表1 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询起始时间戳,只能传0点毫秒时间戳 end_time 是 Long 查询结束时间戳,只能传0点毫秒时间戳 domain_name 是 String 域名列表,多个域名以逗号(半角)分隔,如:www.test1.com,www.test2.com all表示查询名下全部域名。如果域名在查询时间段内无数据,结果将不返回该域名的信息。 stat_type 是 String 参数类型支持:flux(流量),req_num(请求数) service_area 否 String 服务区域:mainland_china(大陆),outside_mainland_china(海外),默认为global(全球) enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。
  • 请求示例 查询TOP100 URL访问次数明细 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-url?&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=req_num&service_area=mainland_china&enterprise_project_id=all 查询TOP100 URL流量明细 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-url?&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&service_area=mainland_china&enterprise_project_id=all
  • 功能介绍 查询TOP100 URL明细。 支持查询90天内的数据。 查询跨度不能超过31天。 起始时间和结束时间,左闭右开,需要同时指定。如查询2021-10-24 00:00:00 到 2021-10-25 00:00:00 的数据,表示取 [2021-10-24 00:00:00, 2021-10-25 00:00:00)的统计数据。 开始时间、结束时间必须传毫秒级时间戳,且必须为凌晨0点整时刻点,如果传的不是凌晨0点整时刻点,返回数据可能与预期不一致。 流量类指标单位统一为Byte(字节)、请求数类指标单位统一为次数。用于查询指定域名、指定统计指标的明细数据。 单租户调用频率:5次/s。
  • 功能介绍 支持查询90天内的数据。 支持多指标同时查询,不超过5个。 最多同时指定20个域名。 起始时间和结束时间需要同时指定,左闭右开,毫秒级时间戳,且时间点必须为与查询时间间隔参数匹配的整时刻点。比如查询时间间隔为5分钟时,起始时间和结束时间必须为5分钟整时刻点,如:0分、5分、10分、15分等,如果时间点与时间间隔不匹配,返回数据可能与预期不一致。统一用开始时间表示一个时间段,如:2019-01-24 20:15:00 表示取 [20:15:00, 20:20:00)的统计数据,且左闭右开。 action取值:location_detail,location_summary 流量类指标单位统一为Byte(字节)、带宽类指标单位统一为bit/s(比特/秒)、请求数类和状态码类指标单位统一为次数。用于查询指定域名、指定统计指标的区域运营商明细数据。 单租户调用频率:15次/s。
  • 请求示例 不分组域名详情数据 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-location-stats?action=location_summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&country=cn&province=sichuan&isp=dianxin&enterprise_project_id=all 按域名分组域名详情数据 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-location-stats?action=location_summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&country=cn&province=sichuan&isp=dianxin&group_by=domain&enterprise_project_id=all
  • URI GET /v1.0/cdn/statistics/domain-location-stats 表1 Query参数 参数 是否必选 参数类型 描述 action 是 String 动作名称,可选location_summary、location_detail。 location_summary:查询汇总数据 location_detail:查询数据详情。 start_time 是 Long 查询起始时间戳,需与结束时间戳同时指定,左闭右开,设置方式如下: interval为300时,start_time设置为整5分钟时刻点,如:1631240100000(对应2021-09-10 10:15:00) interval为3600时,start_time设置为整小时时刻点,如:1631239200000(对应2021-09-10 10:00:00) interval为86400时,start_time设置为东8区零点时刻点,如:1631203200000(对应2021-09-10 00:00:00) end_time 是 Long 查询结束时间戳,需与开始时间戳同时指定,左闭右开,设置方式如下: interval为300时,end_time设置为整5分钟时刻点,如:1631243700000(对应2021-09-10 11:15:00) interval为3600时,end_time设置为整小时时刻点,如:1631325600000(对应2021-09-11 10:00:00) interval为86400时,end_time设置为东8区零点时刻点,如:1631376000000(对应2021-09-12 00:00:00) domain_name 是 String 域名列表,多个域名以逗号(半角)分隔,如:www.test1.com,www.test2.com all表示查询名下全部域名。如果域名在查询时间段内无数据,结果将不返回该域名的信息。 stat_type 是 String 网络资源消耗 bw(带宽) flux(流量) 访问情况 req_num(请求总数) HTTP状态码(组合指标) http_code_2xx(状态码汇总2xx) http_code_3xx(状态码汇总3xx) http_code_4xx(状态码汇总4xx) http_code_5xx(状态码汇总5xx) status_code_2xx(状态码详情2xx) status_code_3xx(状态码详情3xx) status_code_4xx(状态码详情4xx) status_code_5xx(状态码详情5xx) interval 否 Long 查询时间间隔,单位:秒,取值说明: 300(5分钟):最大查询跨度2天 3600(1小时):最大查询跨度7天 86400(1天):最大查询跨度31天 如果不传,默认取对应时间跨度的最小间隔。 country 否 String 国家&地区编码,多个以英文逗号分隔,all表示全部,取值见附录 访问运营商统计数据时不能填写 访问top_url数据时不能填写 访问区域情况数据时只能填写cn(中国) province 否 String 省份编码,当country为cn(中国)时有效,多个以英文逗号分隔,all表示全部,取值见附录 isp 否 String 运营商编码,多个以英文逗号分隔,all表示全部,取值见附录 group_by 否 String 数据分组方式,多个以英文逗号分隔,可选domain、country、province、isp,默认不分组 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。
  • 响应示例 状态码: 200 正常响应 不分组域名详情数据 { "result" : { "flux" : [ 0, 1, 2 ] } } 按域名分组域名详情数据 { "group_by" : "domain", "result" : { "www.test1.com" : { "flux" : [ 0, 1, 2 ] }, "www.test2.com" : { "flux" : [ 0, 1, 2 ] } } } 按国家分组域名详情数据 { "group_by" : "country", "result" : { "cn" : { "flux" : [ 0, 1, 2 ] }, "jp" : { "flux" : [ 0, 1, 2 ] } } } 按省份分组域名详情数据 { "group_by" : "province", "result" : { "sichuan" : { "flux" : [ 0, 1, 2 ] }, "hubei" : { "flux" : [ 0, 1, 2 ] } } } 按运营商分组域名详情数据 { "group_by" : "isp", "result" : { "dianxin" : { "flux" : [ 0, 1, 2 ] }, "liantong" : { "flux" : [ 0, 1, 2 ] } } } 按域名、国家分组域名详情数据 { "group_by" : "domain,country", "result" : { "www.test1.com" : { "cn" : { "flux" : [ 0, 1, 2 ] }, "gb" : { "flux" : [ 0, 1, 2 ] } }, "www.test2.com" : { "cn" : { "flux" : [ 0, 1, 2 ] }, "gb" : { "flux" : [ 0, 1, 2 ] } } } } 按域名、运营商分组域名详情数据 { "group_by" : "domain,isp", "result" : { "www.test1.com" : { "dianxin" : { "req_num" : [ 0, 1, 2 ] } }, "www.test2.com" : { "dianxin" : { "req_num" : [ 0, 1, 2 ] } } } } 不分组域名总体数据 { "result" : { "flux" : 1024 } } 按域名分组域名总体数据 { "group_by" : "domain", "result" : { "www.test1.com" : { "flux" : 1024 }, "www.test2.com" : { "flux" : 1024 } } } 按国家分组域名总体数据 { "group_by" : "country", "result" : { "cn" : { "flux" : 1024 }, "jp" : { "flux" : 1024 } } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 tags Array of Map objects 标签列表 表3 Map 参数 参数类型 描述 key String 标签键。长度1-128个字符, 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @ value String 标签值。长度0-255个字符, 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源id。 说明: 域名ID tags 是 Array of Map objects 标签列表。 表2 Map 参数 是否必选 参数类型 描述 key 是 String 标签键。长度1-128个字符, 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @ value 否 String 标签值。长度0-255个字符, 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @
  • 请求示例 POST https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/tags { "resource_id" : "test_resource_id", "tags" : [ { "key" : "test_key_1", "value" : "test_value_1" }, { "key" : "test_key_2", "value" : "test_value_2" } ] }
共100000条