YD∕T 3903-2021 内容分发网络技术要求 内容服务提供商侧接口(通信).pdf
《YD∕T 3903-2021 内容分发网络技术要求 内容服务提供商侧接口(通信).pdf》由会员分享,可在线阅读,更多相关《YD∕T 3903-2021 内容分发网络技术要求 内容服务提供商侧接口(通信).pdf(45页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、ICS 35.110 M11 YD 中华人民共和国通信行业标准 YD/T XXXXXXXXX 内容分发网络技术要求 内容服务提供商侧接口 Techinical requirements for content distribution(delivery)network-content provider side interface (报批稿)XXXX-XX-XX 发布 XXXX-XX-XX 实施 中华人民共和国工业和信息化部 发 布 I 目 次 前 言.IV 引 言.V 1 范围.1 2 规范性引用文件.1 3 术语定义及缩略语.1 3.1 术语和定义.1 3.2 缩略语.2 4 系统概述.2
2、 5 接口通用要求.3 6 接口实现方式 1.6 6.1 基础功能.6 6.2 对象管理.12 6.3 数据交换.14 6.4 自查功能.18 7 接口实现方式 2.19 7.1 基础功能.19 7.2 对象管理.28 7.3 数据交换.33 7.4 自查功能.36 附录 A(资料性)信息表.40 II 前 言 本标准是内容分发网络技术要求系列标准之一,该系列标准名称和结构如下:内容分发网络技术要求 功能体系架构 内容分发网络技术要求 内容路由 内容分发网络技术要求 应用场景和需求 内容分发网络技术要求 互联应用场景 内容分发网络技术要求 边缘节点 内容分发网络技术要求 接口 内容分发网络技术
3、要求 业务流程 内容分发网络技术要求 云分发 内容分发网络技术要求 支持https的认证系统 内容分发网络技术要求 功能性框架 内容分发网络技术要求 汇聚节点 内容分发网络技术要求 内容中心 内容分发网络技术要求 业务统计信息 内容分发网络技术要求 全局路由节点 内容分发网络技术要求 用户侧接口 本标准按照GB/T 1.1-2009给出的规则起草。请注意本标准的某些内容可能涉及专利。本标准的发布机构不承担识别这些专利的责任。本标准由中国通信标准化协会提出并归口。本标准主要起草单位:阿里云计算有限公司、华为技术有限公司、腾讯云科技有限公司、西安邮电大学、中国信息通信研究院、中国电信集团有限公司、
4、新华三技术有限公司、上海诺基亚贝尔股份有限公司、陕西省信息化工程研究院。本标准主要起草人:李克、张大江、孙腾飞、贾政、郝冲、姚振扬、袁林、李伟、张勇、聂秀英、杨崑、陈戈、唐宏、廖龙、王晓月、朱志祥、万晓兰、黄峰。III 引 言 内容分发网络服务商提供功能接口给内容服务提供商使用。随着内容分发网络服务的发展,内容分发网络服务商及其所服务的内容服务提供商对接口的自动化要求越来越高,需要解决的主要问题包括:a)内容分发网络服务商需要服务多家内容服务提供商,接口标准不一致,内容服务提供商对接口的要求不合理;b)内容服务提供商所对接内容分发网络服务商的接口功能要求类似,但实现和格式多种多样,导致重复性劳
5、动;c)内容管控需要从源头抓起,管理指令到达内容分发网络终端信息不透明、记录格式不统一。通过制定内容服务提供商侧接口要求,可有效地解决上述问题,对规范和统一我国内容分发网络服务的运行、服务和管理,提高内容分发网络服务的技术服务能力和互联互通能力,规范内容分发网络服务市场,推动我国内容分发网络服务的广泛应用十分必要。1 内容分发网络技术要求 内容服务提供商侧接口 1范围 本标准规定了内容分发网络中的内容服务提供商侧侧接口要求,包括功能要求、内容管理要求、数据信息要求和接口安全要求。本标准适用于内容分发网络服务商和内容服务提供商。2规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的
6、引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。YD/T 3212-2017 内容分发网络服务 信息安全管理系统接口规范 3术语定义及缩略语 3.1术语和定义 下列术语和定义适用于本文件。3.1.1 内容分发网络 content delivery network 增值电信业务,定义详见中华人民共和国电信条例附录电信业务分类目录。来源:YD/T 3212-2017,定义3.3 3.1.2 内容分发网络服务商 content delivery network service provider 内容分发网络的提供者,将访问量较大的网页内容和对
7、象保存在服务器前端的专用缓存设备上,以此来提高网站访问的速度和质量,包括但不限于网页加速、下载加速、流媒体加速等。3.1.3 内容服务提供商 content service provider 内容分发网络的使用者,在内容分发网路上提供内容并进行内容加速,包括通过内容分发网络服务商获得网页加速、下载加速、流媒体加速等服务。3.1.4 2 加速域名 speedup domain 需要进行内容分发的网站或应用所使用的域名,即使用CDN加速服务的域名。3.1.5 源站 origin site 存储用户原始数据的主机。使用内容分发网络加速的内容从源站获取。3.1.6 访问用户 access user 访
8、问使用CDN网络进行内容加速的有关网站和应用的外部用户。3.1.7 CNAME 记录 CNAME record 别名,可用来把一个域名解析到另一个域名,当 DNS 系统在查询 CNAME 左面的名称的时候,都会转向 CNAME 右面的名称再进行查询。3.1.8 数字证书 digital certificate 由证书认证机构(CA)对证书申请者真实身份验证之后,用CA的根证书对申请人的一些基本信息以及申请人的公钥进行签名(相当于加盖发证书机 构的公章)后形成的一个数字文件。3.2缩略语 下列缩略语适用于本文件。AK:接入密钥(Access Key)CDN:内容分发网络(Content Deli
9、very Network)CDNUI:内容管理网络接口(Content Delivery Network User Interface)DNS:域名解析服务(Domain Name System)HTTP:超文本传输协议(Hypertext transfer protocol)HTTPS:安全文本传输协议(Hypertext transfer protocol over Secure)IDC:互联网数据中心(Internet Data Center)ISP:互联网服务提供商(Internet Service Provider)IP:互联网协议(Internet Protocol)JSON:数据
10、交换格式(JavaScript Object Notation)SK:加密密钥(Secret Key)XML:可扩展标记语言(Extensible Markup Language)URL:统一资源定位符(Uniform Resource Locator)4系统概述 3 CDN用户侧接口(CDNUI)是内容分发网络服务商提供给内容服务提供商的一整套功能接口,满足用户在配置、监控、内容、监管等方面的功能和数据要求。内容分发网络服务商和内容服务提供商,监管方之间的调用关系如图1所示。图1 CDN用户侧接口调用关系 本标准规定了接口调用要求和用户侧的基本功能列表要求。内容分发网络服务商应支持第7章或第
11、8章中的接口实现方式之一。5接口通用要求 5.1通讯方式 内容分发网络服务商应提供一个CDN API的服务接口地址(URL),端口默认为80,如果支持HTTPS,则端口应为443。内容服务提供商应按照接口说明,在请求中加入相应请求参数来完成预定的指令。内容分发网络服务商应返回结果对内容服务提供商的请求的处理结果。5.2请求方法 内容分发网络服务商应支持HTTP GET发送请求,请求参数应包含在请求的URL中。如果是POST调用,对应的参数应封装在请求体中。注:GET 指从指定的资源请求数据。POST 指向指定的资源提交要被处理的数据。5.3请求参数 内容服务提供商发起的请求应包含公共参数和功能
12、参数。公共参数是每次调用都应携带的,主要用于版本选择,鉴权信息携带等。功能参数是对应的操作需要的,如针对资源申请,查询数据等场景。公共参数如表1所示。内容分发网络服务商内容服务提供商CDNUI监管方下发要求下发要求响应请求 4 表1公共参数 参数 类型 要求 示例 描述 ServiceProvider 字符串 必选 Aliyun 内容分发网络服务商的编码见附录A。Action 字符串 必选 AddCdnDomain 接口调用的功能名称。Version 字符串 必选 2018-01-01 API版本号,为日期形式,如YYYY-MM-DD。AccessKeyId 字符串 必选 XXXXXX 服务商
13、颁发给用户的密钥ID,标识访问者的身份,用于鉴权信息Signature的生成。Signature 字符串 必选 XXXXXX 签名结果串,服务商通过验证结果串来确保请求方身份,关于签名计算要求见6.5。Timestamp 字符串 必选 YYYY-MM-DDThh:mm:ssZ 请求的时间戳。日期格式按照ISO8601标准表示,并应使用UTC时间。SignatureMethod 字符串 必选 HMAC-SHA256 支持的签名算法,内容分发网络服务商可提供多个签名算法。SignatureVersion 字符串 必选 1.0 签名算法版本,内容分发网络服务商可提供多个版本的签名算法。Signatu
14、reNonce 字符串 必选 XXXXXX 唯一随机数,用于防止网络重放攻击,用户在不通的请求间要使用不通的随机数。Format 字符串 可选 JSON 返回结果值的类型,应支持JSON格式,宜支持XML格式。5.4返回结果 内容服务提供商发起调用API服务后,内容分发网络服务商应返回结果状态码。状态码200表示请求调用成功。状态码非200时表示请求调用失败。调用成功返回结果的数据格式默认为JSON格式,可支持XML格式。内容服务提供商可在请求时设置参数来指定返回结果内容的数据格式。返回结果内容应包含RequestId,用来唯一确定本次调用,方便排查问题。如果是查询类返回结果,应将返回结果信息
15、封装到返回结果体中。内容服务提供商可通过解析返回结果的结果数据来进行业务处理。正常情况下,内容分发网络服务商应对添加域名的请求返回结果一个RequestId,为记录该操作的唯一id,用于审计和问题排查,返回结果格式可灵活组织,可包含Code和Message。例:RequestId:8906582E-6722-409A-A6C4-0E7863B733A5,/*返回结果数据*/或者 Response:RequestId:8906582E-6722-409A-A6C4-0E7863B733A5,/*返回结果数据*/5 如果出现异常,内容分发网络服务商应在响应消息的Code和Message字段返回结果
16、错误提示信息,用于告诉内容提供商接口执行的错误原因。内容服务提供商可根据返回结果的Code和Message字段来进行异常分析。例如:RequestId:8906582E-6722-409A-A6C4-0E7863B733A5,Code:UnsupportedOperation,Message:The specified action is not supported.5.5鉴权要求 内容服务提供商发起的请求参数中应将鉴权信息带上,以便内容分发网络服务商进行安全性校验。内容分发网络服务商向内容服务提供商提供AccessKeyId和AccessKeySecret,其中AccessKeyId用于标识
17、内容服务提供商的身份,AccessKeySecret是用于加密签名字符串和服务器端验证签名字符串的密钥。内容分发网络服务商和内容服务提供商应保证AccessKeySecret的机密性,内容分发网络服务商应提供AccessKeySecret管理和更新机制。内容服务提供商在访问时,可按照下面的方法一、或者方法二对请求进行签名处理:方法一:a)使用请求参数构造规范化的请求字符串,对所有请求参数按参数名做字典序升序排列;b)将步骤1中排序好的请求参数格式化成参数名=参数值的形式,参数之间用&连接;c)拼接签名字符串:请求方法+&+UrlEncode(请求路径)+&+UrlEncode(请求参数字符串)
18、;d)生成签名串:使用签名算法对上一步中获得的签名字符串进行签名,然后将生成的签名串使用Base64进行编码,即可获得最终的签名串。计算签名时使用的Key就是用户持有的AccessKeyId对应的AccessKeySecret;e)签名串编码:生成的签名串并不能直接作为请求参数,应对其进行URL编码。生成的签名串需要放到请求的URL中,对应6.3公共参数的Signature字段。方法二:a)构造规范请求。将待发送的请求内容按照与 API 网关后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。使用 AK/SK 方式进行签名与认证。应首先规范请求内容,然后再进行签名;b)
19、使用规范请求和其他信息创建待签字符串。对 HTTP 请求进行规范并取得请求的哈希值后,将其与签名算法、签名时间一起组成待签名字符串;c)使用 AK 或 SK 和待签字符串计算签名。将 SK(Access Secret Key)和创建的待签字符串作为加密哈希函数的输入,计算签名,将二进制值转换为十六进制表示形式;d)将生成的签名信息作为请求消息头添加到 HTTP 请求中,或者作为查询字符串参数添加到 HTTP请求中。5.6幂等要求 6 通过调用接口使用 CDN 的服务时,如果发生请求超时或服务器内部错误,内容服务提供商可能会尝试重发请求,这时内容分发网络服务商应确保多次请求的结果是一致的,不会造
20、成重复资源申请或者配置冗余。5.7字符编码 内容服务提供商发起的请求及返回结果应使用UTF-8字符集进行编码。5.8错误结果 内容服务提供商调用接口出错时,内容分发网络服务商将不会返回结果数据。内容服务提供商可根据Code和Message返回结果信息来定位自身错误原因。6接口实现方式 1 6.1基础功能 7.1.1 加速域名管理 7.1.1.1 添加加速域名 此功能允许内容服务提供商一次添加一个加速域名。内容服务提供商添加多个加速域名时应使用相同的配置。内容服务提供商调用接口时应提供源站信息,可指定其它配置信息。内容服务提供商使用的加速域名应在工信部备案。对应的Action为AddCdnDom
21、ain,其它参数携带该功能的一些必要信息,如表2所示。表2添加加速域名 参 数 类型 要求 示例 描述 Action 字符串 必选 AddCdnDomain 该操作应传入的参数。Area 字符串 可选 mainland 加速区域包括:mainland:中国大陆加速(默认选项)overseas:纯海外加速 global:全球加速 ServiceType 字符串 必选 web 加速域名的业务类型,包括:web:网页和小图片加速 download:下载加速 video:视频加速 liveStream:流媒体加速 DomainName 字符串 必选 要操作的加速域名,可选择支持泛加速域名,以“.”开头
22、,例如“”。Origin 字符串 必选 content:1.1.1.1,回源地址采用JSON格式。可设置优先级priority和权重weight。7 type:ipaddr,priority:20,port:80,weight:15 ,content:,type:domain,priority:20,port:80,weight:20 源站类型可使用加速域名或IP,包括:ipv4:IpV4格式 ipv6:IpV6格式 domain:加速域名格式 Configs 字符串 可选 ConfigName:CacheConfig,ConfigValues:ArgName:suffix,ArgValue:
23、jpg,ArgName:ttl,ArgValue:300 ,ConfigName:ReferConfig,ConfigValues:ArgName:white,ArgValue:, ,ConfigName:IpConfig,ConfigValues:CacheConfig功能用于设定缓存策略,应支持:path:路径 suffix:后缀 ttl:缓存时间,单位为秒 ReferConfig功能用于设定refer访问控制策略,应支持:black:禁止该refer访问 white:允许该refer IpConfig功能用于指定IP地址访问控制策略,应支持:black:IP黑名单 white:IP白名单
24、 8 正常情况下,添加一个加速域名后,处理完成该加速域名的服务状态应是“online”,可正常使用的加速服务,可通过查询加速域名接口获取对应的CNAME用于DNS解析,返回结果如表3所示。表3添加加速域名返回结果 参数 类型 示例 描述 RequestId 字符串 15C66C7B-671A-4297-9187-2C4477247A74 RequestId 注:如果内容分发网络服务商对于用户状态有要求,可单独管理,例如应开通服务才可使用该接口,本标准对服务状态不做强制要求。加速域名的状态应如表4所示。表4加速域名状态 参数 要求 示例 描述 运行中 必选 online 加速域名启用中,可正常服
25、务。已停止 必选 offline 加速域名已经停止服务,无法提供加速。配置中 必选 configuring 加速域名当前正在配置,需要等待。封禁中 必选 block 加速域名当前由于违禁暂时不能服务。审核中 可选 checking 加速域名在审核中,可作为服务商的选择手段。删除中 可选 deleting 加速域名删除中,需要等待删除操作完成。审核失败 可选 check_failed 由于加速域名有违禁行为,无法提供加速域名加速服务。7.1.1.2 停用加速域名 内容服务提供商停用状态为“online”的加速域名,将加速域名状态变更为“offline”。对应的Action为StopCdnDoma
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- YDT 3903-2021 内容分发网络技术要求 内容服务提供商侧接口通信 YD 3903 2021 内容 分发 网络技术 要求 服务 提供商 接口 通信
限制150内