文档中心 API文档 获取应用场景列表

获取应用场景列表

更新时间:2023-04-21 17:53:21

适用产品

云直播

接口描述

获取应用场景列表

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称类型必填描述
createUser
String创建用户。默认为空,允许传多个,以半角逗号隔开,不能以逗号开头或结尾,两个逗号之间的内容不为能为空或空白字符。该参数受权限限制,只能查询子账户或权限特殊配置的用户。
startTime
String查询起始时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询;
endTime
String查询截止时间,时间格式为,2016-01-01 12:00:00;用于按创建时间段查询,小于当前查询时间;
listOrder
Integer列表排列顺序,取值范围 :
0(按创建时间降序排列)
1(按创建时间升序排列)默认为0
pageIndex
Integer取场景列表第几页,从1开始取值,默认为1。入参pageIndex和pageSize的乘积必须不大于100000。
pageSize
Integer平均每页场景数量,取值范围1-50,默认为10。入参pageIndex和pageSize的乘积必须不大于100000。

返回参数

Body 参数

参数名称类型描述
code
Integer状态码
message
String操作信息
data
List返回数据
sceneId
String场景Id
sceneName
String场景名称
createTime
String场景创建时间
createUser
String场景创建的用户

错误码

错误代码(code)描述(message)HTTP状态码语义
24112000Parameter error400参数错误

示例

JSON
JSON
请求示例
复制代码 复制成功
#!/bin/bash
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/live/channelManage/getSceneList" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "x-cnc-auth-method: BASIC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
	"createUser":"username",
	"startTime":"2020-05-06 19:07:40",
	"endTime":"2020-05-06 19:37:40",
	"listOrder":1,
	"pageIndex":1,
	"pageSize":5
}'
返回示例
复制代码 复制成功
{
	"code": 200,
	"message": "操作成功",
	"data": :[{
                         "sceneId":"1",
                         "sceneName":"场景1",
                         "createTime":"2016-02-01 12:00:00",
                         "createUser":"user1",
                 },
                 {
                         "sceneId":"2",
                         "sceneName":"场景2",
                         "createTime":"2016-02-01 12:00:00",
                         "createUser":"user2",
                 }
        ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!