CDI通信接口规范

CDI（Content Delivery Interface）通信接口规范是一套用于系统间通过SOAP协议以XML格式进行信息交换的标准。此规范详细规定了消息传输的格式和内容，确保了数据交换的准确性和高效性。 CDI规范定义了接口的通信流程，其中涉及两个主要的参与者：消息发送端和消息接收端。通常情况下，发送端是内容管理系统，它负责将信息发送给门户或其他系统进行处理。接收端则根据消息的具体内容执行相应的动作，如处理内容分发完成后的PlayUrl上报。 在接口定义方面，CDI规范使用HTTP作为传输层协议，并且使用XML格式对消息进行编码。协议的这种方式是为了解决不同的系统之间通信时可能出现的数据格式不一致的问题。 具体到参数说明部分，CDI规范将消息分为请求参数和响应参数： 1. 请求参数包括： - Taskid：这是一个字符串类型，必填项，代表分发任务的唯一标识符。 - original-content-idx：该参数为字符串类型，非必须，用于标识原始内容。 - content-idx：这是一个字符串类型，必填项，用于标识内容。 - subcontent-idx：同样是字符串类型，必填项，用于标识子内容。 - target-system-idx：字符串类型，必填项，代表目标系统标识。 - target-channel-idx：字符串类型，非必须，标识目标区域。 - begin-time和end-time：分别表示任务开始和结束的时间，数据类型为dateTime，且为必填。 - status：任务状态的数值类型，必填项。 - error-code：非必须的字符串类型，用于描述错误代码。 - Play-url：CDN内容分发完成后，需要上报的播放URL，通常包含在CDATA段中以确保URL的正确性。 2. 响应参数包括： - Result：结果码，字符串类型，必填项，用来表示操作的成功或失败。 - 若值为"1"，表示操作成功。 - 若值为"0"，表示操作失败。 - description：结果描述，字符串类型，非必须项，用于补充说明操作结果。 此外，CDI规范还给出了请求消息和响应消息的具体示例。在请求消息中，XML文档的header部分包含了消息的基本信息，如时间戳、序列号、组件ID和类型、操作动作及具体指令。body部分则包含了具体任务的参数，以及PlayUrl的上报信息。响应消息的格式与请求消息类似，但主要在于响应的header中会标明是响应动作，而body中则返回操作的结果码和描述。 整个CDI规范是一个标准化的信息交换框架，有助于统一不同系统间通信的标准，降低系统集成的复杂度。它还强调了数据的完整性和错误处理，比如通过提供错误码来帮助接收端准确地识别出请求失败的具体原因。 该规范的使用场景非常广泛，特别是在需要高效、安全地传输大量数据的媒体内容分发网络中。例如，它可以帮助内容分发网络（CDN）提供商将内容正确地上报给门户或统计系统，确保内容的准确追踪和计费。 CDI通信接口规范是系统间通信的一个重要标准，它以XML over HTTP的形式通过SOAP协议进行数据交换，确保了系统之间交互的数据准确性和完整性。它适用于多种应用场景，尤其在内容管理系统中扮演着至关重要的角色。