CDI规范.docx
《CDI规范.docx》由会员分享，可在线阅读，更多相关《CDI规范.docx（23页珍藏版）》请在冰点文库上搜索。
CDI规范
CDI
iCMSCDISpec（Ver1.0.8）
前言
为满足华数互联网电视等项目需要，iCMS3.3版本支持内容分发接口，用于异构系统与iCMS交互完成内容分发功能，内容分发完成后，iCMS上报异构系统最终[ContMgt:
PlayUrl]等信息。
2接口定义
接口沿用思华XMLoverHTTP协议的xml消息规范，包含message、header、body等元素，不再赘述。
2.1分发任务添加接口（DELIVERY_TASK_ADD）
消息发送端：
CLPS或其它异构系统
消息接收端：
iCMS
接口协议：
XMLoverHTTP
2.1.1参数说明
2.1.1.1请求参数
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:
dateTime
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-删除中
error-code
xs:
string
No
错误码（当且仅当status=0时生效）
1000-未知错误
1001-内容标识不存在
1002-子内容标识不存在
1003-目标系统标识不存在
1004-目标频道/应用标识不存在
2.1.2消息示例
2.1.2.1请求消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000001"component-id="iCMS_01"component-type="iCMS"action="REQUEST"command="DELIVERY_TASK_ADD"/>
00:
00.0Z"/>00:
00.0Z"/>
2.1.2.2回应消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000002"component-id="CLPS_01"component-type="CLPS"action="RESPONSE"command="DELIVERY_TASK_ADD"/>
2.2分发任务删除接口（DELIVERY_TASK_DELETE）
消息发送端：
CLPS或其它异构系统
消息接收端：
iCMS
接口协议：
XMLoverHTTP
2.2.1参数说明
2.2.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
子内容标识
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:
string
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请求消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000001"component-id="iCMS_01"component-type="iCMS"action="REQUEST"command="DELIVERY_TASK_DELETE"/>
2.2.2.2回应消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000002"component-id="iCMS_01"component-type="iCMS"action="RESPONSE"command="DELIVERY_TASK_DELETE"/>
2.3分发结果上报接口（DELIVERY_TASK_DONE）
消息发送端：
iCMS
消息接收端：
CLPS或其它异构系统
接口协议：
XMLoverHTTP
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-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请求消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000001"component-id="iCMS_01"component-type="iCMS"action="REQUEST"command="DELIVERY_TASK_DONE"/>
00:
00.0Z"end-time="2010-11-16T00:
00:
00.0Z"status="6">[CDATA[rtsp:
//00:
00.0Z"end-time="2010-11-16T00:
00:
00.0Z"status="5"error-code="1000">[CDATA[rtsp:
//
2.3.1.2回应消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000002"component-id="iCMS_01"component-type="iCMS"action="RESPONSE"command="DELIVERY_TASK_DONE"/>
2.4任务状态设定接口（DELIVERY_TASK_STATUS_SET）
消息发送端：
CLPS或其它异构系统
消息接收端：
iCMS
接口协议：
XMLoverHTTP
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
子内容标识
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
目标系统标识
status
xs:
number
Yes
状态
2.4.2消息示例
2.4.2.1请求消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000001"component-id="iCMS_01"component-type="iCMS"action="REQUEST"command="DELIVERY_TASK_STATUS_SET"/>
2.4.2.2回应消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000002"component-id="iCMS_01"component-type="iCMS"action="RESPONSE"command="DELIVERY_TASK_STATUS_SET"/>
2.4分发任务查询接口（DELIVERY_TASK_QUERY）
消息发送端：
CLPS或其它异构系统
消息接收端：
iCMS
接口协议：
XMLoverHTTP
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
子内容标识
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
目标频道/应用标识
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请求消息
xmlversion="1.0"encoding="UTF-8"?
>00:
00.0Z"sequence="1000002"component-id="CLPS_01"component-type="CLPS"action="REQUEST"command="DELIVERY_TASK_QUERY"/>
升级会员 