华为云用户手册

  • 请求示例 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/statistics-excel?start_time=1667030400000&end_time_1667116800000&domain_name=www.test1.com&excel_language=zh&service_area=mainland_china&interval=300&enterprise_project_id=all&excel_type=excel_type_usage
  • URI GET /v1.0/cdn/statistics/statistics-excel 表1 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询起始时间戳,时间戳应设置需为整5分钟,设置方式如下: 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 查询结束时间戳,时间戳应设置需为整5分钟,设置方式如下: 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表示查询名下全部域名 excel_language 否 String 创建表格语言,支持zh(中文),en(英文)两种,如果不传默认为zh service_area 否 String 服务区域:mainland_china(默认)、outside_mainland_china,当查询回源类指标时该参数无效。 interval 否 Long 查询时间间隔,单位:秒,取值说明: 300(5分钟):最大查询跨度2天 3600(1小时):最大查询跨度7天 86400(1天):最大查询跨度31天 如果不传,默认取对应时间跨度的最小间隔。 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 excel_type 是 String 统计数据表格类型,目前支持 用量统计数据(excel_type_usage) 访问情况统计数据(excel_type_access) 回源情况统计数据(excel_type_origin) http_code统计数据(excel_type_http_code)
  • 功能介绍 下载统计指标数据表格文件。 支持下载90天内的指标数据。 时间跨度不能超过31天。 起始时间和结束时间,左闭右开。如时间跨度为2022-10-24 00:00:00 到 2022-10-25 00:00:00,表示取 [2022-10-24 00:00:00, 2022-10-25 00:00:00)的统计数据。 起始时间、结束时间必须传毫秒级时间戳,起始时间和结束时间必须同时指定。 单租户调用频率:10次/min。
  • 请求消息 请求参数 请求参数如表1所示。 表1 请求参数 名称 是否必选 参数类型 描述 start_time 否 Long 查询起始时间戳(单位:毫秒)。 end_time 否 Long 查询结束时间戳(单位:毫秒)。 domain_name 是 String 域名列表,多个域名以逗号(半角)分隔,如:www.test1.com,www.test2.com ,ALL表示查询名下全部域名。单次最多可查询100个。 interval 否 Integer 采样间隔,单位:秒,取值说明: 时间跨度1天:5分钟、1小时、4小时、8小时,分别对应300秒、3600秒、14400秒和28800秒。 时间跨度2~7天:5分钟、1小时、4小时、8小时、1天,分别对应300秒、3600秒、14400秒、28800秒和86400秒。 时间跨度8~31天:4小时、8小时、1天,分别对应14400秒、28800秒和86400秒。 如果不传,默认取对应时间跨度的最小间隔。 stat_type 是 String 参数类型支持:bw(带宽),flux(流量),bs_bw(回源带宽),bs_flux(回源流量),bs_num(回源总数),bs_fail_num(回源失败总数),req_num(请求总数),req_hit_rate(请求命中率),flux_hit_rate(流量命中率),bs_fail_rate(回源失败率),qps(每秒请求数),http_code_2xx(状态码2xx),http_code_3xx(状态码3xx),http_code_4xx(状态码4xx),http_code_5xx(状态码5xx)。 service_area 否 String mainland_china(中国大陆),outside_mainland_china(中国大陆境外),默认为mainland_china,回源指标bs_flux,bs_bw,bs_fail_rate,回源指标不区分服务范围,该参数对回源指标无效。 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 请求示例 请求路径示例 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-summary-detail?start_time=1498838400000&end_time=1502380500000&domain_name=www.example.com&interval=300&stat_type=bs_flux&enterprise_project_id=0
  • 响应消息 响应参数 响应参数如表2所示。 表2 响应参数 名称 参数类型 描述 domain_summary_detail Object 详情数据对象。详细说明见表3。 domain_summary_detail参数说明 domain_summary_detail参数说明如表3所示。 表3 domain_summary_detail参数说明 名称 参数类型 描述 start_time Integer 查询起始时间戳(单位:毫秒)。 end_time Integer 查询结束时间戳(单位:毫秒)。 interval Integer 采样间隔,单位:秒。 values Array of integers 从start_time开始,每采样间隔生成一个采样点,按时间顺序排列,每个采样点数据类型为long。(流量单位:Byte,带宽单位:bps) stat_type String 统计类型。 service_area String mainland_china(中国大陆),outside_mainland_china(中国大陆境外)。回源指标不区分服务范围,该参数对回源指标无效。 响应示例 { "domain_summary_detail": { "interval": 300, "values": [835038583,835038584], "start_time": 1498838400000, "end_time": 1502380500000, "stat_type": "bs_flux", "service_area": "outside_example_china" } }
  • URI GET /v1.0/cdn/domains/{domain_id}/referer 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 加速域名ID。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 referer RefererRsp object Referrer配置。 表5 RefererRsp 参数 参数类型 描述 referer_type Integer Referer类型。取值:0代表不设置Referer过滤;1代表黑名单;2代表白名单。默认取值为0。 referer_list String 配置的referer地址。 include_empty Boolean 是否包含空Referer。如果是黑名单并开启该选项,则表示无referer不允许访问。如果是白名单并开启该选项,则表示无referer允许访问。默认不包含,true:包含,false:不包含。
  • 请求消息 请求参数 请求参数如表2所示。 表2 请求参数 名称 是否必须 参数类型 描述 urls 是 Array of strings 输入示例:http://abc.com/image/1.png,多个URL之间需要用逗号分隔,目前不支持对目录的预热,单个url的长度限制为10240字符,单次最多输入1000个url。 请求示例 请求路径示例 POST https://cdn.myhuaweicloud.com/v1.0/cdn/preheatingtasks?enterprise_project_id=0 { "preheatingTask":{ "urls":[ "http://www.example1.com/index.html", "http://www.example2.com/web" ] } }
  • 响应消息 响应参数 响应参数如表3所示。 表3 响应参数 名称 参数类型 描述 id String 任务id。 task_type String 任务的类型, 其值可以为refresh| preheating。 status String 预热结果。task_done表示预热成功 ,task_inprocess表示预热中。 processing Integer 处理中的url个数。 succeed Integer 成功处理的url个数。 failed Integer 处理失败的url个数。 total Integer 总共的任务个数。 create_time Integer 任务创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 urls Array of strings 预热的url。 响应示例 { "preheatingTask" : { "id" : "ff8080*********************c6e", "status" : "task_inprocess", "processing" : 2, "succeed" : 0, "failed" : 0, "urls" : [ "http://www.example1.com/index.html", "http://www.example2.com/web" ], "task_type" : "preheating", "total" : 2, "create_time" : 0 } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 headers 否 HeaderMap object 设置HTTP头参数的值。 表5 HeaderMap 参数 是否必选 参数类型 描述 Content-Disposition 否 String 指示回复的内容该以何种形式展示 Content-Language 否 String 说明访问者希望采用的语言或语言组合 Access-Control-Allow-Origin 否 String 指定了该响应的资源是否被允许与给定的origin共享 Access-Control-Allow-Methods 否 String 明确了客户端所要访问的资源允许使用的方法或方法列表 Access-Control-Max-Age 否 String Access-Control-Allow-Methods 和Access-Control-Allow-Headers 提供的信息可以被缓存多久 Access-Control-Expose-Headers 否 String 列出了哪些首部可以作为响应的一部分暴露给外部
  • 请求示例 PUT https://cdn.myhuaweicloud.com/v1.0/cdn/domains/ff808***********************307d/response-header { "headers" : { "Content-Disposition" : "test.xml", "Content-Language" : "en-US", "Access-Control-Max-Age" : "86400" } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 headers HeaderMap object HTTP头值。 表7 HeaderMap 参数 参数类型 描述 Content-Disposition String 指示回复的内容该以何种形式展示 Content-Language String 说明访问者希望采用的语言或语言组合 Access-Control-Allow-Origin String 指定了该响应的资源是否被允许与给定的origin共享 Access-Control-Allow-Methods String 明确了客户端所要访问的资源允许使用的方法或方法列表 Access-Control-Max-Age String Access-Control-Allow-Methods 和Access-Control-Allow-Headers 提供的信息可以被缓存多久 Access-Control-Expose-Headers String 列出了哪些首部可以作为响应的一部分暴露给外部
  • URI PUT /v1.0/cdn/domains/{domain_id}/response-header 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 加速域名ID。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示修改当前企业项目下加速域名的配置,"all"代表所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。
  • 响应示例 状态码: 200 OK { "logs" : [ { "domain_name" : "www.example.com", "start_time" : 1498838400000, "end_time" : 1502380500000, "name" : "www.xxxx.com-2017080315", "link" : "www.xxxx.web", "size" : 4096 } ], "total" : 1 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 总数。 logs Array of LogObject objects 日志列表数据。 表4 LogObject 参数 参数类型 描述 domain_name String 域名名称。 start_time Long 查询起始时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 end_time Long 查询结束时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 name String 日志文件名字。 size Long 文件大小(Byte)。 link String 下载链接。
  • URI GET /v1.0/cdn/logs 表1 Query参数 参数 是否必选 参数类型 描述 domain_name 是 String 只支持单个域名,如:www.test1.com。 start_time 否 Long 查询开始时间,时间格式为整点毫秒时间戳,此参数传空值时默认为当天0点。 end_time 否 Long 查询结束时间(不包含结束时间),时间格式为整点毫秒时间戳,与开始时间的最大跨度为30天,此参数传空值时默认为开始时间加1天。 page_size 否 Integer 单页最大数量,取值范围为1-10000,默认值:10。 page_number 否 Integer 当前查询第几页,取值范围为1-65535,默认值:1。 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 cache_config CacheConfig object 缓存配置。 表5 CacheConfig 参数 参数类型 描述 ignore_url_parameter Boolean 是否忽略url中的参数。 follow_origin Boolean 缓存规则是否遵循源站。 compress CompressResponse object GZIP压缩. rules Array of Rules objects 缓存规则,将覆盖之前的规则配置。规则为空重置为默认规则。 数组长度:1 - 20 表6 CompressResponse 参数 参数类型 描述 compress_switch Integer GZIP压缩开关。0关闭。1打开 compress_rules Array of CompressRules objects GZIP压缩规则 表7 CompressRules 参数 参数类型 描述 compress_type String GZIP压缩类型(目前只支持 gzip) compress_file_type String GZIP压缩文件类型(文件后缀竖线分割,如:.js|.html|.css|.xml) 表8 Rules 参数 参数类型 描述 rule_type Integer 0:全部类型,表示匹配所有文件,默认值。 1:文件类型,表示按文件后缀匹配。 2:文件夹类型,表示按目录匹配。 3:文件全路径类型,表示按文件全路径匹配,5:缓存首页。 content String 缓存匹配设置。 当rule_type为0时,为空。 当rule_type为1时,为文件后缀,输入首字符为“.”,以“;”进行分隔,如.jpg;.zip;.exe,并且输入的文件名后缀总数不超过20个。 当rule_type为2时,为目录,输入要求以“/”作为首字符,以“;”进行分隔,如/test/folder01;/test/folder02,并且输入的目录路径总数不超过20个。 当rule_type为3时,为全路径,输入要求以“/”作为首字符,支持匹配指定目录下的具体文件,或者带通配符“*”的文件,如/test/index.html或/test/*.jpg。 ttl Integer 缓存时间。最大支持365天。 ttl_type Integer 缓存时间单位。1:秒;2:分;3:小时;4:天。 priority Integer 此条配置的优先级, 默认值1,数值越大,优先级越高。取值范围为1-100,优先级不能相同。
  • 响应示例 状态码: 200 OK { "cache_config" : { "rules" : [ { "rule_type" : 1, "content" : ".jpg;.png", "ttl" : 30, "ttl_type" : 3, "priority" : 1 }, { "rule_type" : 0, "content" : "", "ttl" : 600, "ttl_type" : 1, "priority" : 1 } ], "ignore_url_parameter" : false, "follow_origin" : false, "compress" : { "compress_switch" : 1, "compress_rules" : [ { "compress_type" : "gzip", "compress_file_type" : ".js|.html|.css|.xml|.json|.shtml|.htm" } ] } } }
  • URI GET /v1.0/cdn/domains/{domain_id}/cache 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 加速域名ID。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。
  • 请求示例 GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-domain-names?start_time=1667030400000&end_time_1667116800000&stat_type=bw&service_area=mainland_china&limit=100&enterprise_project_id=all
  • 响应示例 { "top_domain_names": [ { "domain_name": "www.test1.com", "flux": 10000000 }, { "domain_name": "www.test2.com", "flux": 20000000 }, { "domain_name": "www.test3.com", "flux": 30000000 } ] }
  • 功能介绍 查询TOP域名。 支持查询90天内的数据。 查询时间跨度不能超过1天。 起始时间和结束时间,左闭右开,必须同时指定。如查询2022-10-24 00:00:00 到 2022-10-25 00:00:00 的数据,表示取 [2022-10-24 00:00:00, 2022-10-25 00:00:00)的统计数据。 起始时间、结束时间必须传整点毫秒级时间戳。 流量类指标单位统一为Byte(字节)、带宽类指标单位统一为bit/s(比特/秒)、请求数类和状态码类指标单位统一为次数。用于查询指定域名、指定统计指标的明细数据。 单租户调用频率:5次/s。
  • URI GET /v1/cdn/statistics/top-domain-names 表1 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询起始时间戳,时间戳应设置需为整点时间戳,设置方式如下: 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为3600时,end_time设置为整小时时刻点,如:1631325600000(对应2021-09-11 10:00:00) interval为86400时,end_time设置为东8区零点时刻点,如:1631376000000(对应2021-09-12 00:00:00) stat_type 是 String 统计类型 目前只支持bw(带宽),flux(流量),req_num(请求总数) service_area 否 String 服务区域:mainland_china(默认)、outside_mainland_china,当查询回源类指标时该参数无效。 limit 否 Integer top域名查询数量,默认为20,最大为500,最小为0 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。
  • 响应消息 响应参数 响应参数如表3所示。 表3 响应参数 名称 参数类型 描述 id String 任务id。 task_type String 任务的类型, 其值可以为refresh或preheating。 status String 刷新结果。task_done表示刷新成功 ,task_inprocess表示刷新中。 processing Integer 处理中的url个数。 succeed Integer 成功处理的url个数。 failed Integer 处理失败的url个数。 total Integer 总共的任务个数。 create_time Integer 任务创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 urls Array of strings 刷新缓存的url列表。 响应示例 { "refreshTask" : { "id" : "ff808***********************2b35", "status" : "task_inprocess", "processing" : 2, "succeed" : 0, "failed" : 0, "urls" : [ "http://www.example1.com/index.html", "http://www.example2.com/web" ], "task_type" : "refresh", "total" : 2, "create_time" : 0 } }
  • 请求消息 请求参数 请求参数如表2所示。 表2 请求参数 名称 是否必选 参数类型 描述 type 否 String 刷新的类型, 其值可以为file 或directory,默认为file。 urls 是 Array of strings 输入示例:http://abc.com/image/1.png,多个URL之间需要用逗号分隔,单个url的长度限制为10240字符,单次最多输入1000个url。 请求示例 请求路径示例 POST https://cdn.myhuaweicloud.com/v1.0/cdn/refreshtasks?enterprise_project_id=0 { "refreshTask":{ "type":"file", "urls":[ "http://www.example.com/index.html", "http://www.example.com/web" ] } }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 https UpdateDomainMultiCertificatesResponseBodyContent object https配置。 表7 UpdateDomainMultiCertificatesResponseBodyContent 参数 参数类型 描述 domain_name String 域名列表。 https_switch Integer https开关(0:"关闭";1:"设置证书")。 access_origin_way Integer 回源方式:1:"回源跟随";2:"HTTP"(默认),3:https(自建)。 force_redirect_https Integer 强制跳转HTTPS(0:不强制;1:强制) 。 force_redirect_config ForceRedirect object 强制跳转。 http2 Integer http2.0(0:关闭;1:开启) cert_name String 证书名称。 certificate String 证书内容。 certificate_type Integer 证书类型(0为自有证书 , 1为托管证书)。 expiration_time Long 证书过期时间。 表8 ForceRedirect 参数 参数类型 描述 switch Integer 强制跳转开关。1打开。0关闭。 redirect_type String 强制跳转类型。http:强制跳转HTTP。https:强制跳转HTTPS。
  • 响应示例 状态码: 200 OK { "https" : { "domain_name" : "example1.com", "https_switch" : 1, "access_origin_way" : 2, "force_redirect_https" : 1, "force_redirect_config" : { "redirect_type" : "https", "switch" : 1 }, "http2" : 0, "expiration_time" : 1925791912000, "cert_name" : "cdn_test_cert", "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "certificate_type" : 0 } }
  • 请求示例 { "https" : { "domain_name" : "example1.com", "access_origin_way" : 2, "http2" : 0, "certificate_type" : 0, "force_redirect_config" : { "redirect_type" : "https", "switch" : 1 }, "https_switch" : 1, "cert_name" : "cdn_test_cert", "certificate" : "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "private_key" : "-----BEGIN RSA PRIVATE KEY---------END RSA PRIVATE KEY-----" } }
  • URI PUT /v1.0/cdn/domains/config-https-info 表1 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 当用户开启企业项目功能时,该参数生效,表示修改当前企业项目下加速域名的配置,"all"代表所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 https 否 UpdateDomainMultiCertificatesRequestBodyContent object https配置。 表4 UpdateDomainMultiCertificatesRequestBodyContent 参数 是否必选 参数类型 描述 domain_name 是 String 域名列表,逗号分割,上限50个域名 https_switch 是 Integer https开关(0:"关闭";1:"设置证书" https_switch为1时,证书参数不能为空) access_origin_way 否 Integer 回源方式:1:"回源跟随";2:"http"(默认),3:"https" 为空值时默认设置为http force_redirect_https 否 Integer 强制跳转HTTPS(0:不强制;1:强制) 为空值时默认设置为关闭。(此参数即将下线,建议使用force_redirect_config修改配置) force_redirect_config 否 ForceRedirect object 强制跳转。 http2 否 Integer http2.0(0:关闭;1:开启) 为空值时默认设置为关闭 cert_name 否 String 证书名称(设置证书必填)(长度限制为3-64字符)。 certificate 否 String HTTPS协议使用的SSL证书内容,仅支持PEM编码格式。不启用证书则无需输入。初次配置证书时必传。 private_key 否 String HTTPS协议使用的SSL证书私钥内容,仅支持PEM编码格式。不启用证书则无需输入。初次配置证书时必传。 certificate_type 否 Integer 证书类型(0为自有证书 ;1为托管证书,此时不必不传入证书内容和私钥,自动根据证书名称匹配;不传默认为自有证书) 表5 ForceRedirect 参数 是否必选 参数类型 描述 switch 是 Integer 强制跳转开关。1打开。0关闭。 redirect_type 否 String 强制跳转类型。http:强制跳转HTTP。https:强制跳转HTTPS。
共100000条