huawei-cloud-api-definitions-VIS 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"GetNVRChannelResponseBody":{"properties":{"channels":{"description":"通道列表详情。","items":{"$ref":"#/definitions/NVRChannels"},"type":"array"},"channels_query":{"description":"设备通道更新状态。\n- IDEL:表示设备通道列表未进行更新,或者更新失败。\n- QUERYING:表示设备通道列表更新中。\n- QUERIED:表示设备通道列表更新成功。","example":"IDEL","type":"string"},"created_at":{"description":"设备注册时间。","example":"","type":"string"},"description":{"description":"描述信息。","example":"","type":"string"},"device_id":{"description":"设备ID。","example":"3402000000**********","type":"string"},"state":{"description":"设备状态。","example":"UNREGISTERED","type":"string"},"suffix":{"description":"视频流名称后缀。","example":"aaa","type":"string"},"type":{"description":"设备类型。","example":"NVR","type":"string"},"updated_at":{"description":"更新时间。","example":"","type":"string"},"username":{"description":"设备注册时所使用的GB/T28181用户名。","example":"0000","type":"string"}}},"NVRChannels":{"properties":{"channel_id":{"description":"通道ID。","example":"921740312913240*****","type":"string"},"created_at":{"description":"通道注册时间,格式为:YYYY-MM-DDTHH:MM:SSZ(UTC时间)。","example":"2018-09-30T03:59:08Z","type":"string"},"invitation_status":{"description":"邀约状态。\n- UNREGISTERED:未注册。\n- ONLINE:未邀约。\n- INVITING:正在邀约。\n- INVITE_SUCCESS:邀约成功。\n- CANCELING:正在取消。\n- TEMPORARY_OFFLINE:暂时掉线。\n- OFFLINE:已下线。","example":"INVITING","type":"string"},"stream_id":{"description":"通道关联的视频流ID。","example":"stream-0P5g9fQ2","type":"string"},"stream_name":{"description":"通道关联的视频流名称。","example":"channel_9217403129**********_9217403129**********","type":"string"},"suffix":{"description":"视频流名称后缀。","example":"aaa","type":"string"},"tcp_priority":{"description":"是否配置通道优先选择TCP协议传输。\n- TRUE:是。\n- FALSE:否。\n\n默认值FALSE。","example":"TRUE","type":"string"},"tcp_support":{"description":"通道是否支持TCP协议传输。取值范围如下。\n- TRUE:是。\n- FALSE:否。\n\n默认值FALSE。","example":"TRUE","type":"string"},"updated_at":{"description":"通道更新时间,格式为:YYYY-MM-DDTHH:MM:SSZ(UTC时间)。","example":"2018-09-30T03:59:08Z","type":"string"}}}},"description":null,"group_id":"5346b7c1dc284228a28795d5bcbd550d","host":"vis.cn-north-4.myhuaweicloud.com","id":"ebff9cfcb7354e16a89c0290c950e63f","info_version":"v1","method":"get","name":"ListNvrChannels","parameters":{},"paths":{"/v1/{project_id}/devices/{device_id}":{"get":{"consumes":[],"deprecated":false,"description":"此接口用于获取已经注册成功的NVR设备通道列表。","operationId":"ListNvrChannels","parameters":[{"description":"项目ID","in":"path","name":"project_id","required":true,"type":"string","x-example":"3266392d188c47d09948b1**********"},{"description":"设备ID","in":"path","name":"device_id","required":true,"type":"string","x-example":"91267042471180***026"},{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCC*****...","x-order":1}],"produces":[],"responses":{"200":{"description":"正常","examples":{"application/json":{"channels":[{"channel_id":"9217403129**********","created_at":"2018-09-30T03:59:08Z","invitation_status":"INVITE_SUCCESS","stream_id":"stream-0P5g9fQ2","stream_name":"channel_9217403129***************4031291324069792","suffix":"aaa","updated_at":"2018-09-30T03:59:08Z"}],"channels_query":"IDEL","created_at":"2018-09-30T03:59:08Z","description":"description for device","device_id":"912670424711***00026","state":"ONLINE","suffix":"aaa","type":"NVR","updated_at":"2018-09-30T03:59:08Z","username":"0000"}},"schema":{"$ref":"#/definitions/GetNVRChannelResponseBody"}},"400":{"description":"请求错误","examples":{"application/json":{"error_code":"VIS.0005","error_msg":"Invalid request parameter, offset should be in range [0, 100000]."}}}},"summary":"获取NVR设备通道列表","tags":["设备管理"],"x-apiexplorer-hide":"N","x-is-registered":"Y","x-name":"获取NVR设备通道列表","x-request-examples-url-1":"GET /v1/3266392d188c47d09948b1**********/devices/91267042471***00026","x-support-sdk":"Y"}}},"product_short":"VIS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取NVR设备通道列表","tags":"设备管理","uri":null,"version":"2.0"}