首页
产品
帮助文档
博客
控制台

监控矩阵接口

接口目录

获取临时授权

GET /monitor_matrix/api/get_tmp_auth_token

URL 参数

参数 描述 取值
perm 权限类型 string
expire_at 过期时间 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
tmp_auth_token 临时token, 可以放入cookie,或者在每次接口调用时,在请求头或url参数上带上该值 string

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"tmp_auth_token": "7b5a3d04,ALL,1551421253,d5f31fc1b50bf593eab6705de1b4bf6f2b0cd2f45037221d771768cbe6b0086d"
}

监控区域列表

GET /monitor_matrix/api/list_monitor_area

返回字段

参数 描述 取值
monitor_areas.id ID string
monitor_areas.name 区域名称 string

返回示例:

{
	"errcode": 1000,
	"monitor_areas": [{
		"id": "17lok52y",
		"name": "北京",
		"created_at": "2019-02-13T11:50:32+08:00"
	}, {
		"id": "8olnj57x",
		"name": "西安",
		"created_at": "2019-02-15T17:11:24+08:00"
	}],
	"msg": ""
}

监控矩阵列表

GET /monitor_matrix/api/list_monitor_matrix

URL 参数

参数 描述 取值
search 监控矩阵id或名称,可选 string
kind 监控矩阵类型 int, 0普通矩阵, 1无节点矩阵
page 页数,默认 1 int
page_size 每页个数,默认 15 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_matrices 矩阵列表 object array
monitor_matrices.id 矩阵ID string
monitor_matrices.kind 类型 int
monitor_matrices.name 名称 string
monitor_matrices.status 状态, 1已开始 2已暂停 int
monitor_matrices.closed_at 关闭时间 string
monitor_matrices.crated_at 创建时间 string
count 总数 int

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"monitor_matrices": [{
		"id": "17lokk52",
		"kind": 0,
		"name": "log",
		"status": 2,
		"closed_at": "2019-01-31T12:07:54+08:00",
		"created_at": "2019-01-28T10:08:09+08:00"
	}],
	"count": 1
}

添加监控矩阵

POST /monitor_matrix/api/add_monitor_matrix

JSON 参数

参数 描述 取值
kind 矩阵类型 int,0普通矩阵, 1无节点矩阵
name 矩阵名称 string
close_timestamp 关闭时间 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_matrix_id 监控矩阵ID string

返回示例:

{
	"errcode": 1000,
	"monitor_matrix_id": "j90eo564",
	"msg": ""
}

删除监控矩阵

POST /monitor_matrix/api/del_monitor_matrix

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

批量删除监控矩阵

POST /monitor_matrix/api/del_monitor_matrices

URL 参数

参数 描述 取值
monitor_matrix_ids 监控矩阵hashID,逗号分隔 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

开始监控矩阵

POST /monitor_matrix/api/start_monitor_matrix

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string
close_timestamp 关闭时间 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

暂停监控矩阵

POST /monitor_matrix/api/pause_monitor_matrix

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

修改监控矩阵关闭时间

POST /monitor_matrix/api/modify_monitor_matrix_closed_at

JSON 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string
close_timestamp 关闭时间 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

获取监控矩阵

GET /monitor_matrix/api/get_monitor_matrix

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_matrix 监控矩阵 object
monitor_matrix.id 监控矩阵ID string
monitor_matrix.kind 类型 int
monitor_matrix.name 名称 string
monitor_matrix.status 状态, 1已开始 2已暂停 int
monitor_matrix.closed_at 关闭时间 string
monitor_matrix.created_at 创建时间 string

返回示例:

{
	"msg": "",
	"errcode": 1000,
	"monitor_matrix": {
		"id": "17lokk52",
		"kind": 0,
		"name": "log",
		"status": 1,
		"closed_at": "2019-02-03T12:07:54+08:00",
		"created_at": "2019-01-28T10:08:09+08:00"
	}
}

监控源列表

GET /monitor_matrix/api/list_monitor_source

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string
page 页数,默认 1 int
page_size 每页个数,默认 15 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_sources 监控源列表 object array
monitor_sources.id 监控源ID string
monitor_sources.name 监控源名称 string
monitor_sources.source_url 源地址 string
monitor_sources.live_channel_id 直播ID string
monitor_sources.status 状态, 1已开始 2已暂停 int
monitor_sources.monitor_matrix_id 监控矩阵ID string
monitor_sources.created_at 创建时间 string
monitor_sources.playsets 播放列表 object array
monitor_sources.playsets.region 地区 string
monitor_sources.playsets.protocol 协议 string
monitor_sources.playsets.resolution 分辨率 string
monitor_sources.playsets.address 地址 string
count 总数 int

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"monitor_sources": [{
		"id": "v353y1lb",
		"name": "11",
		"source_url": "rtmp://122.112.240.199:31935/live/ke74l84m?authkey=1863485258-ecba2d0a13ef4a471647a2ead0b2ed39",
		"live_channel_id": "kd04m8oo",
		"weight": 1,
		"status": 1,
		"monitor_matrix_id": "17lokk52",
		"created_at": "2019-01-28T10:32:06+08:00",
		"playsets": [{
			"region": "mainland",
			"test_addr": "",
			"protocol": "rtmp",
			"resolution": "origin",
			"address": "rtmp://streaming.myun.tv/live/kd04m8oo?auth_key=1548916138-743219-0-3734e892462aa0c0348fcf2262f86e01"
		}, {
			"region": "mainland",
			"test_addr": "",
			"protocol": "hls",
			"resolution": "origin",
			"address": "http://streaming.myun.tv/live/kd04m8oo.m3u8?auth_key=1548916138-822500-0-92f0d51818e070dd204db100f55563b4"
		}, {
			"region": "mainland",
			"test_addr": "",
			"protocol": "flv",
			"resolution": "origin",
			"address": "http://streaming.myun.tv/live/kd04m8oo.flv?auth_key=1548916138-560539-0-fc1debd84f59a6453a4c003263d51213"
		}]
	}],
	"count": 1
}

添加监控源

POST /monitor_matrix/api/add_monitor_source

JSON 参数

参数 描述 取值
name 名称 string
source_url 源地址 string
monitor_matrix_id 监控矩阵id string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_source_id 监控源ID string

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"monitor_source_id": "aksdf"
}

移动监控源

POST /monitor_matrix/api/move_monitor_source

URL 参数

参数 描述 取值
from_monitor_source_id 待移动的监控源id string
to_monitor_source_id 要移动到前后的监控源id string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

删除监控源

POST /monitor_matrix/api/del_monitor_source

URL 参数

参数 描述 取值
monitor_source_id 监控源ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

监控流列表

GET /monitor_matrix/api/list_monitor_stream

URL 参数

参数 描述 取值
monitor_source_ids 监控流id,逗号分隔 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_streams 监控流列表 object array
monitor_streams.id 监控流ID string
monitor_streams.area 地区 string
monitor_streams.name 名称 string
monitor_streams.stream_url 流地址 string
monitor_streams.monitor_source_id 监控源ID string
monitor_streams.created_at 创建时间 string

返回示例:

{
	"errcode": 1000,
	"monitor_streams": [{
		"id": "49518zl6",
		"area": "beijing",
		"name": "1",
		"stream_url": "rtmp://122.112.240.199:31935/live/ke74l84m?authkey=1863485258-ecba2d0a13ef4a471647a2ead0b2ed39",
		"agent_addr": "192.168.0.14:55589",
		"monitor_source_id": "v353y1lb",
		"weight": 1,
		"status": 1,
		"created_at": "2019-01-28T10:34:23+08:00"
	}],
	"msg": ""
}

添加监控流

POST /monitor_matrix/api/add_monitor_stream

JSON 参数

参数 描述 取值
area_id 区域id string
name 名称 string
stream_url 监控地址 string
monitor_source_id 监控源id string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
monitor_stream_id 监控流id string

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"monitor_stream_id": "kadsjfk"
}

移动监控流

POST /monitor_matrix/api/move_monitor_stream

URL 参数

参数 描述 取值
from_monitor_stream_id 移动的监控流id string
to_monitor_stream_id 要移动到前后的监控流id string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

删除监控流

POST /monitor_matrix/api/del_monitor_stream

URL 参数

参数 描述 取值
monitor_stream_id 监控流ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": ""
}

获取监控流信号强度

GET /monitor_matrix/api/list_matrix_quota

URL 参数

参数 描述 取值
monitor_matrix_id 监控矩阵ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
matrix_quotas 指标数据列表 object array
matrix_quotas.empty 取空次数 int
matrix_quotas.sum 取帧次数 int
matrix_quotas.fps 帧率 float
matrix_quotas.kbpsv 视频码率 int
matrix_quotas.kbpsa 音频码率 int
matrix_quotas.time 时间 string
matrix_quotas.stream_id 监控流ID string
matrix_quotas.source_id 监控源ID string
matrix_quotas.matrix_id 监控矩阵ID string

返回示例:

{
	"errcode": 1000,
	"matrix_quotas": [{
		"empty": 0,
		"sum": 125,
		"fps": 30.2,
		"kbpsv": 2516908,
		"kbpsa": 2064,
		"time": "2019-01-30T14:48:14+08:00",
		"stream_id": "nzlxe45p",
		"source_id": "7d5zjo0n",
		"matrix_id": "7b5ad54o"
	}],
	"msg": ""
}

获取监控流指标数据

GET /monitor_matrix/api/list_stream_quota

URL 参数

参数 描述 取值
monitor_stream_id 监控流ID string
start_at 开始时间 string
end_at 结束时间 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
stream_quotas 流指标数据 object array
stream_quotas.empty 取空次数 int/null
stream_quotas.sum 取帧次数 int/null
stream_quotas.fps 帧率 float/null
stream_quotas.kbpsv 视频码率 int/null
stream_quotas.kbpsa 音频码率 int/null
stream_quotas.time 时间 string

返回示例:

{
	"errcode": 1000,
	"msg": "",
	"stream_quotas": [{
		"empty": 0,
		"sum": 125,
		"fps": 29.6,
		"kbpsv": 2466870,
		"kbpsa": 2072,
		"time": "2019-01-30T14:53:00+08:00"
	}, {
		"empty": null,
		"sum": null,
		"fps": null,
		"kbpsv": null,
		"kbpsa": null,
		"time": "2019-01-30T14:48:10+08:00"
	}]
}