ThingsKit物联网平台API文档-视频中心（流媒体配置）

云腾小编

2024年10月21日2024年10月18日

流媒体配置新增|编辑

接口地址:/api/yt/video/platform

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "appKey": "",
  "appSecret": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "host": "",
  "icon": "",
  "id": "",
  "name": "",
  "roleIds": [],
  "ssl": 0,
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "type": 0,
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
tkVideoPlatformDTO	TkVideoPlatformDTO	body	true	TkVideoPlatformDTO
appKey	秘钥appKey		true	string
appSecret	秘钥appSecret		true	string
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
host	平台地址+端口		true	string
icon	租户图标		false	string
id	ID		false	string
name	租户名称		false	string
roleIds	租户角色列表		false	array
ssl	流媒体部署环境		true	integer(int32)
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
type	平台类型		true	integer(int32)
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
appKey	秘钥appKey	string
appSecret	秘钥appSecret	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
host	平台地址+端口	string
icon	租户图标	string
id	ID	string
name	租户名称	string
roleIds	租户角色列表	array
ssl	流媒体部署环境	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	平台类型	integer(int32)
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"appKey": "",
	"appSecret": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"host": "",
	"icon": "",
	"id": "",
	"name": "",
	"roleIds": [],
	"ssl": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"type": 0,
	"updateTime": "",
	"updater": ""
}

流媒体配置删除(待翻译)

接口地址:/api/yt/video/platform

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deleteDTO	DeleteDTO	body	true	DeleteDTO
ids	删除ID列表		true	array
tenantId	租户ID		false	string

响应参数:

参数名称	参数说明	类型
errorCode	Platform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – Too many updates (Too many updates over Websocket session)\n\n* 40 – Subscription violation (HTTP: 403 – Forbidden)	object
message	Error message	string
status	HTTP Response Status Code	integer(int32)
timestamp	Timestamp	string(date-time)

流媒体配置分页

接口地址:/api/yt/video/platform{?host,orderFiled,orderType,page,pageSize}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称	参数说明	是否必须	数据类型
page	page	true	int
pageSize	pageSize	true	int
host	host	false	string
orderFiled	orderFiled	false	string
orderType	orderType,可用值:ASC,DESC	false	string

响应参数:

参数名称	参数说明	类型
items		array
appKey	秘钥appKey	string
appSecret	秘钥appSecret	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
host	平台地址+端口	string
icon	租户图标	string
id	ID	string
name	租户名称	string
roleIds	租户角色列表	array
ssl	流媒体部署环境	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	平台类型	integer(int32)
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"appKey": "",
			"appSecret": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"host": "",
			"icon": "",
			"id": "",
			"name": "",
			"roleIds": [],
			"ssl": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"type": 0,
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}