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
2、 3.1 术语和定义 .1 3.2 缩略语 .2 4 系统概述 .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) 内容分发网络服务商需要服务多家内容
5、服务提供商 , 接口标准不一致 , 内容服务提供商对接口 的要求不合理; b) 内容服务提供商所对接内容分发网络服务商的接口功能要求类似 , 但实现和格式多种多样 , 导 致重复性劳动; c) 内容管控需要从源头抓起,管理指令到达内容分发网络终端信息不透明、记录格式不统一。 通过制定内容服务提供商侧接口要求 , 可有效地解决上述问题 , 对规范和统一我国内容分发网络服 务的运行 、 服务和管理 , 提高内容分发网络服务的技术服务能力和互联互通能力 , 规范内容分发网络服 务市场,推动我国内容分发网络服务的广泛应用十分必要。 1 内容分发网络技术要求 内容服务提供商侧接口 1 范围 本标准规定了
6、内容分发网络中的内容服务提供商侧侧接口要求 , 包括功能要求 、 内容管理要求 、 数 据信息要求和接口安全要求。 本标准适用于内容分发网络服务商和内容服务提供商。 2 规范性引用文件 下列文件对于本文件的应用是必不可少的 。 凡是注日期的引用文件 , 仅注日期的版本适用于本文件 。 凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。 YD/T 3212-2017 内容分发网络服务 信息安全管理系统接口规范 3 术语定义 及缩略语 3.1 术语和定义 下列术语和定义适用于本文件。 3.1.1 内容分发网络 content delivery network 增值电信业务,定义详
7、见中华人民共和国电信条例附录电信业务分类目录。 来源: YD/T 3212-2017,定义 3.3 3.1.2 内容分发网络服务商 content delivery network service provider 内容分发网络的提供者 , 将访问量较大的网页内容和对象保存在服务器前端的专用缓存设备上 , 以 此来提高网站访问的速度和质量,包括但不限于网页加速、下载加速、流媒体加速等。 3.1.3 内容服务提供商 content service provider 内容分发网络的使用者 , 在内容分发网路上提供内容并进行内容加速 , 包括通过内容分发网络服务 商获得网页加速、下载加速、流媒体加速
8、等服务。 3.1.4 2 加速域名 speedup domain 需要进行内容分发的网站或应用所使用的域名,即使用 CDN加速服务的域名。 3.1.5 源站 origin site 存储用户原始数据的主机。使用内容分发网络加速的内容从源站获取。 3.1.6 访问用户 access user 访问使用 CDN网络进行内容加速的有关网站和应用的外部用户。 3.1.7 CNAME 记录 CNAME record 别名 , 可用来把一个域名解析到另一个域名 , 当 DNS 系统在查询 CNAME 左面的名称的时候 , 都会 转向 CNAME 右面的名称再进行查询。 3.1.8 数字证书 digital
9、 certificate 由证书认证机构 ( CA) 对证书申请者真实身份验证之后 , 用 CA的根证书对申请人的一些基本信息以 及申请人的公钥进行签名(相当于加盖发证书机 构的公章)后形成的一个数字文件。 3.2 缩略语 下列缩略语适用于本文件。 AK:接入密钥 ( Access Key) CDN:内容分发网络 ( Content Delivery Network) CDNUI:内容管理网络接口( Content Delivery Network User Interface) DNS:域名解析服务( Domain Name System) HTTP:超文本传输协议( Hypertext t
10、ransfer protocol) HTTPS:安全文本传输协议( Hypertext transfer protocol over Secure) IDC:互联网数据中心( Internet Data Center) ISP:互联网服务提供商( Internet Service Provider) IP:互联网协议( Internet Protocol) JSON:数据交换格式( JavaScript Object Notation) SK:加密密钥( Secret Key) XML:可扩展标记语言( Extensible Markup Language) URL:统一资源定位符( Unif
11、orm Resource Locator) 4 系统概述 3 CDN用户侧接口 ( CDNUI) 是内容分发网络服务商提供给内容服务提供商的一整套功能接口 , 满足用 户在配置、监控、内容、监管等方面的功能和数据要求。 内容分发网络服务商和内容服务提供商,监管方之间的调用关系如图 1所示。 图 1 CDN用户侧接口调用关系 本标准规定了接口调用要求和用户侧的基本功能列表要求 。 内容分发网络服务商应支持第 7章或第 8 章中的接口实现方式之一。 5 接口通用要求 5.1 通讯方式 内容分发网络服务商应提供一个 CDN API的服务接口地址( URL), 端口默认为 80,如果支持 HTTPS,
12、 则端口应为 443。 内容服务提供商应按照接口说明 , 在请求中加入相应请求参数来完成预定的指令 。 内容分发网络服 务商应返回结果对内容服务提供商的请求的处理结果。 5.2 请求方法 内容分发网络服务商应支持 HTTP GET发送请求,请求参数应包含在请求的 URL中。 如果是 POST调用, 对应的参数应封装在请求体中。 注: GET 指从指定的资源请求数据。 POST 指向指定的资源提交要被处理的数据。 5.3 请求参数 内容服务提供商发起的请求应包含公共参数和功能参数。 公共参数是每次调用都应携带的 , 主要用于版本选择 , 鉴权信息携带等 。 功能参数是对应的操作需 要的,如针对资
13、源申请,查询数据等场景。 公共参数如表 1所示。 内容分发网络 服务商 内容服务 提供商 CDNUI 监管方 下发 要求 下发 要求 响应 请求 4 表 1 公共参数 参数 类型 要求 示例 描述 ServiceProvider 字符串 必选 Aliyun 内容分发网络服务商的编码见附录 A。 Action 字符串 必选 AddCdnDomain 接口调用的功能名称。 Version 字符串 必选 2018-01-01 API版本号,为日期形式,如 YYYY-MM-DD。 AccessKeyId 字符串 必选 XXXXXX 服务商颁发给用户的密钥 ID, 标识访问者的身份,用于鉴权信息 Sig
14、nature的生成。 Signature 字符串 必选 XXXXXX 签名结果串 , 服务商通过验证结果串来确保请求方身份,关于签名计算要求见 6.5。 Timestamp 字符串 必选 YYYY-MM-DDThh:mm:ssZ 请求的时间戳。日期格式按照 ISO8601标准表示,并应使用 UTC时间。 SignatureMethod 字符串 必选 HMAC-SHA256 支持的签名算法 , 内容分发网络服务商可提供多个签名算法。 SignatureVersion 字符串 必选 1.0 签名算法版本 , 内容分发网络服务商可提供多个版本的签名算法。 SignatureNonce 字符串 必选
15、XXXXXX 唯一随机数 , 用于防止网络重放攻击 , 用户在不通的请求间要使用不通的随机数。 Format 字符串 可选 JSON 返回结果值的类型 , 应支持 JSON格式 , 宜支持 XML格式。 5.4 返回结果 内容服务提供商发起调用 API服务后 , 内容分发网络服务商应返回结果状态码 。 状态码 200表示请求 调用成功。状态码非 200时表示请求调用失败。 调用成功返回结果的数据格式默认为 JSON格式,可支持 XML格式。内容服务提供商可在请求时设置 参数来指定返回结果内容的数据格式 。 返回结果内容应包含 RequestId,用来唯一确定本次调用,方便排查问题。 如果是查询
16、类返回结果 , 应将返回结果信息封装到返回结果体中 。 内容服务提供商可通过解析返回 结果的结果数据来进行业务处理。 正常情况下,内容分发网络服务商应对添加域名的请求返回结果一个 RequestId,为记录该操作的 唯一 id,用于审计和问题排查,返回结果格式可灵活组织,可包含 Code和 Message。例: RequestId:8906582E-6722-409A-A6C4-0E7863B733A5, /* 返回结果数据 */ 或者 Response: RequestId:8906582E-6722-409A-A6C4-0E7863B733A5,/* 返回结果数据 */ 5 如果出现异常,
17、内容分发网络服务商应在响应消息的 Code和 Message字段返回结果错误提示信息, 用于告诉内容提供商接口执行的错误原因。内容服务提供商可根据返回结果的 Code和 Message字段来进 行异常分析。例如: RequestId: 8906582E-6722-409A-A6C4-0E7863B733A5, Code: UnsupportedOperation, Message: The specified action is not supported. 5.5 鉴权要求 内容服务提供商发起的请求参数中应将鉴权信息带上,以便内容分发网络服务商进行安全性校验 。 内容分发网络服务商向内容服务
18、提供商提供 AccessKeyId和 AccessKeySecret,其中 AccessKeyId用 于标识内容服务提供商的身份, AccessKeySecret是用于加密签名字符串和服务器端验证签名字符串的 密钥。内容分发网络服务商和内容服务提供商应保证 AccessKeySecret的机密性 ,内容分发网络服务商 应提供 AccessKeySecret管理和更新机制。 内 容服务提供商在访问时,可按照下面的方法一、或者方法二对请求进行签名处理: 方法一: a) 使用请求参数构造规范化的请求字符串,对所有请求参数按参数名做字典序升序排列; b) 将步骤 1中排序好的请求参数格式化成 参数名
19、=参数值 的形式,参数之间用 分号隔开的域名列表。 include_empty Boolean 可选 false 是否包含空 Referer。 如果是黑名单并开启该选项 , 则表示 无 referer不允许访问。 如果是白名单并开启该选项 , 则表示 无 referer允许访问。 设置 Referer过滤规则返回结果见表 50。 8.1.2.2.4 更新缓存规则 设置 CDN节点上缓存资源的缓存策略对应的 Action = URI: PUT /./domains/domainId/cache,参数说明见表 40。请求参数如表 54所示。 表 54 设置缓存规则请求参数 名称 类型 要求 示例
20、描述 cache_config 对象 必选 缓存配置对象。详细说明见 表 55。 表 55 cache_config 参数说明 名称 类型 要求 示例 描述 ignore_url_parameter Boolean 可选 false 是否忽略 url中的参数。 rules 数组对象 可选 缓存规则,将覆盖之前的规 则配置。规则为空重置为默 认规则 。 详细信息参见下表 。 详细说明见表 56。 表 56 rules 参数说明 名称 类型 要求 示例 描述 rule_type 整数型 必选 1 0:全部类型,表示匹配所有文件,默认值。 1:文件类型,表示按文件后缀匹配。 27 名称 类型 要求
21、示例 描述 2:文件夹类型,表示按目录匹配。 3:文件全路径类型,表示按文件全路径匹配。 content 字符串 可选 .jpg;.png 缓存匹配设置。 当 rule_type为 0时,为空。 当 rule_type为 1时 , 为文件后缀 , 输入首字符为 “.”, 以 “;”进行分隔,如 .jpg;.zip;.exe。 当 rule_type为 2时,为目录,输入要求以 “/”作为首 字 符 , 以 “;” 进 行 分 隔 , 如 /test/folder01;/test/folder02。 ttl 整数型 必选 30 缓存时间。最大支持 365天。 ttl_type 整数型 必选 3
- 1.请仔细阅读文档,确保文档完整性,对于不预览、不比对内容而直接下载带来的问题本站不予受理。
- 2.下载的文档,不会出现我们的网址水印。
- 3、该文档所得收入(下载+内容+预览)归上传者、原创作者;如果您是本文档原作者,请点此认领!既往收益都归您。
下载文档到电脑,查找使用更方便
5000 积分 0人已下载
下载 | 加入VIP,交流精品资源 |
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- YD 3903-2021 内容分发网络技术要求 内容服务提供商侧接口 3903 2021 内容 分发 网络技术 要求 服务 提供商 接口
