CDI规范.docx

1、CDI规范CDIiCMS CDI Spec (Ver 1.0.8) 前言为满足华数互联网电视等项目需要，iCMS 3.3版本支持内容分发接口，用于异构系统与iCMS交互完成内容分发功能，内容分发完成后，iCMS上报异构系统最终ContMgt:PlayUrl等信息。2 接口定义接口沿用思华XML over HTTP协议的xml消息规范，包含message、header、body等元素，不再赘述。2.1 分发任务添加接口（DELIVERY_TASK_ADD）消息发送端： CLPS或其它异构系统 消息接收端： iCMS 接口协议： XML over HTTP 2.1.1 参数说明2.1.1.1 请求

2、参数Task属性 类型 是否必须 说明 content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string No 目标系统标识 当target-system-id不为NULL时（即整个target-system-id属性不存在，非target-system-id=时），分发任务取默认系统 target-channel-id xs:string Yes 目标频道/应用标识 priority xs:number Yes 优先级（数字值越大，优先级越高；） begin-time xs:d

3、ateTime Yes 计划开始时间 2.1.1.2 回应参数Task属性 类型 是否必须 说明 id xs:string Yes 分发任务标识 content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string No 目标系统标识 target-channel-id xs:string Yes 目标频道/应用标识 status xs:number Yes 状态 0 - 分发错误 1 - 初始 2 - 队列中 3 - 分发中 4 - 暂停 5 - 分发失败 6 - 分发成功 7 -

4、 删除中 error-code xs:string No 错误码（当且仅当status=0时生效） 1000 - 未知错误 1001 - 内容标识不存在 1002 - 子内容标识不存在 1003 - 目标系统标识不存在 1004 - 目标频道/应用标识不存在 2.1.2 消息示例2.1.2.1 请求消息 2.1.2.2 回应消息 2.2 分发任务删除接口（DELIVERY_TASK_DELETE）消息发送端： CLPS或其它异构系统 消息接收端： iCMS 接口协议： XML over HTTP 2.2.1 参数说明2.2.1.1 请求消息Task属性 类型 是否必须 说明 id xs:str

5、ing No 分发任务标识（当id非空时，iCMS将忽略content-id、subcontent-id和target-system-id三个属性） content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string No 目标系统标识 target-channel-id xs:string Yes 目标频道（应用）标识 2.2.1.2 回应消息Result属性 类型 是否必须 说明 code xs:string Yes 结果码 1-成功 0-失败 description xs:s

6、tring No 结果描述 Task属性 类型 是否必须 说明 id xs:string No 分发任务标识（当id非空时，iCMS将忽略content-id、subcontent-id和target-system-id三个属性） content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string Yes 目标系统标识 status xs:number Yes 状态 error-code xs:string No 错误码 2.2.2 消息示例2.2.2.1 请求消息 2.2.2.2

7、 回应消息 2.3 分发结果上报接口（DELIVERY_TASK_DONE）消息发送端： iCMS 消息接收端： CLPS或其它异构系统 接口协议： XML over HTTP 2.3.1 参数说明2.3.1.1 请求参数Task属性 类型 是否必须 说明 id xs:string Yes 分发任务标识 original-content-id xs:string No 原内容标识 content-id xs:string No 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string Yes 目标系统标识 target-

8、channel-id xs:string No 目标区域标识 begin-time xs:dateTime Yes 任务开始时间 end-time xs:dateTime Yes 任务完成时间 status xs:number Yes 任务状态 error-code xs:string No 错误码 Play-url属性 类型 是否必须 说明 2.2.1.2 回应消息Result属性 类型 是否必须 说明 code xs:string Yes 结果码 1-成功 0-失败 description xs:string No 结果描述 2.3.1 消息示例2.3.1.1 请求消息 !CDATArts

9、p:/ !CDATArtsp:/ 2.3.1.2 回应消息 2.4 任务状态设定接口（DELIVERY_TASK_STATUS_SET）消息发送端： CLPS或其它异构系统 消息接收端： iCMS 接口协议： XML over HTTP 2.4.1 参数说明2.4.1.1 请求参数Task属性 类型 是否必须 说明 id xs:string No 分发任务标识（当id非空时，iCMS将忽略content-id、subcontent-id和target-system-id三个属性） content-id xs:string Yes 内容标识 subcontent-id xs:string Yes

10、 子内容标识 target-system-id xs:string No 目标系统标识 target-channel-id xs:string Yes 目标频道/应用标识 2.4.1.2 回应参数Task属性 类型 是否必须 说明 id xs:string No 分发任务标识（当id非空时，iCMS将忽略content-id、subcontent-id和target-system-id三个属性） content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string Yes 目标系统标

11、识 status xs:number Yes 状态 2.4.2 消息示例2.4.2.1 请求消息 2.4.2.2 回应消息 2.4 分发任务查询接口（DELIVERY_TASK_QUERY）消息发送端： CLPS或其它异构系统 消息接收端： iCMS 接口协议： XML over HTTP 2.4.1 参数说明2.4.1.1 请求参数Task属性 类型 是否必须 说明 id xs:string No 分发任务标识（当id非空时，iCMS将忽略content-id、subcontent-id和target-system-id三个属性） content-id xs:string Yes 内容标识

12、subcontent-id xs:string Yes 子内容标识 target-system-id xs:string No 目标系统标识 target-channel-id xs:string Yes 目标区域标识 2.4.1.1 回应参数Task属性 类型 是否必须 说明 id xs:string Yes 分发任务标识 content-id xs:string Yes 内容标识 subcontent-id xs:string Yes 子内容标识 target-system-id xs:string No 目标系统标识 target-channel-id xs:string Yes 目标频

13、道/应用标识 priority xs:number Yes 任务优先级 begin-time xs:dateTime No 任务开始时间 end-time xs:dateTime No 任务结束时间 bytes-total xs:long No 总分发任务需要传送字节数 bytes-transfered xs:long No 已完成字节数 status xs:number Yes 状态 0 - 分发错误 1 - 初始 2 - 队列中 3 - 分发中 4 - 暂停 5 - 分发失败 6 - 分发成功 7 - 删除中 error-code xs:string No 错误码（当且仅当status=0时生效） 1000 - 未知错误 1001 - 内容标识不存在 1002 - 子内容标识不存在 1003 - 目标系统标识不存在 2.4.2 消息示例2.4.2.1 请求消息 tas