视频接入服务 VIS-华为云

视频接入服务 VIS-获取项目ID/账号名/AK/SK:调用API获取项目ID

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。响应示例如下，例如VIS部署的区域为"cn-north-4"，相应消息体中查找“name”为"cn-north-4"，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

视频接入服务 VIS

视频接入服务 VIS-获取项目ID/账号名/AK/SK:从控制台获取项目ID

从控制台获取项目ID 登录管理控制台。鼠标移动到右上角的用户名上，在下拉列表中选择“我的凭证”。在“我的凭证”页面，可以查看用户名、账号名，在项目列表中查看项目ID。图1 查看账号ID/项目ID 单击“管理访问密钥”，可以查看已添加的访问密钥ID（Access Key ID，AK）。如果没有AK/SK，可单击“新增访问密钥”来添加。如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。

视频接入服务 VIS

视频接入服务 VIS-返回结果:响应消息体

响应消息体响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-4",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001"} 其中，error_code表示错误码，error_msg表示错误描述信息，具体请参见错误码。

视频接入服务 VIS

视频接入服务 VIS-返回结果:响应消息头

响应消息头对应请求消息头，响应同样也有消息头，如“Content-type”。表1 公共响应消息头消息头名称说明是否必选 Content-Type 用于指明发送给接收者的实体正文的媒体类型。类型：字符串。默认值：application/json; charset=UTF-8 是 X-request-id 此字段携带请求ID号，以便任务跟踪。类型：字符串。request_id-timestamp-hostname（request_id在服务器端生成UUID， timestamp为当前时间戳，hostname为处理当前接口的服务器名称）。默认值：无。否 X-ratelimit 此字段携带总计流控请求数。类型：整型。默认值：无。否 X-ratelimit-used 此字段携带剩下请求数。类型：整型。默认值：无。否 X-ratelimit-window 此字段携带流控单位。类型：字符串。单位按照分钟、小时、天。默认值：小时。否对于获取用户Token接口，返回如图获取用户Token相应消息头所示。其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。图1 获取用户Token响应消息头

视频接入服务 VIS

视频接入服务 VIS-删除AK/SK凭证:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。

视频接入服务 VIS

视频接入服务 VIS-更新AK/SK凭证:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。表3 请求Body参数参数是否必选参数类型描述 name 否 String 凭证名称。长度为1位到32位之间，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 description 否 String 凭证描述，不填为空。可填字符串最大长度为500。

视频接入服务 VIS

视频接入服务 VIS-公共数据结构:列表查询参数（queryOption）

列表查询参数（queryOption）参数是否必选类型说明 offset 否 Integer 查询的开始位置，取值范围为1～100000，必须与limit一起使用。与limit同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。如果offset超过数据总条数，则结果返回空列表。 limit 否 Integer 返回结果的最大条目数，取值范围为1～1000，必须与offset一起使用。与offset同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。 sort 否 String 返回结果的排序规则： ASC：表示升序。 DESC：表示降序。默认为ASC，需要有offset和limit参数，sort参数才会生效。 order_by 否 String 选择按一个字段进行排序，默认按照创建时间（created_at）排序。需要有offset和limit参数，order_by参数才会生效。

视频接入服务 VIS

视频接入服务 VIS-更新视频流:响应示例

响应示例状态码： 200 正常 { "result" : "success"} 状态码： 400 请求错误。具体返回错误码请参考错误码说明 { "error_msg" : "Invalid request parameter, url can not be null or empty when access type is HTTP-FLV.", "error_code" : "VIS.0005"}

视频接入服务 VIS

视频接入服务 VIS-更新NVR设备通道列表:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。

视频接入服务 VIS

视频接入服务 VIS-更新视频流:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。表3 请求Body参数参数是否必选参数类型描述 access_type 否 String 视频接入类型，例如HTTP-FLV、RTMP等，不区分大小写。当视频流处于ACTIVE状态时，不允许修改该项。 encode_type 否 String 视频流编码格式，当前支持H264，不区分大小写。 access_key 否 String RTMP视频流绑定的密钥Access Key。 url 否 String HTTP-FLV视频流的拉流地址。URL必须是http或https协议的合法URL。格式要求：以“http://”或“https://”开头的字符串，例如“http://xxxx.xxx”。 description 否 String 视频流的描述信息。 share_type 否 String 视频流共享类型。 PRIVATE：非共享。 PUBLIC：共享。不区分大小写。 tag 否 Array of StreamTag objects 和视频流关联的标签，一个视频流最多添加10个标签。 state 否 String 视频流状态,可选值如下。 ACTIVE：表示已激活。 STOPPED：表示已停用。表4 StreamTag 参数是否必选参数类型描述 key 否 String 标签的键。最大长度为36个UNICODE字符（一-鿿），可以包含大小写字母、数字、中划线（-）或者下划线（_），不能包含其他的特殊字符。 value 否 String 标签的值。最大长度为43个UNICODE字符（一-鿿），可以包含大小写字母、数字、点（.）、中划线（-）或者下划线（_），不能包含其他的特殊字符，也可以为空字符串。

视频接入服务 VIS

视频接入服务 VIS-错误码

错误码调用API出错后，将不会返回结果数据。调用方可根据每个API对应的错误码来定位错误原因。当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系客服，并提供错误码，以便我们尽快帮您解决问题。异常响应样例 { "error_code": "VIS.0001", "error_msg": "Request body is not a valid json object."} 参数说明参数说明 error_code 错误码。 error_msg 错误信息。错误码说明类别状态码错误码说明服务类公共错误（区间1～100） 403 VIS.0001 Token鉴权失败。 400 VIS.0002 项目ID不合法。 403 VIS.0003 请求非当前Region。 403 VIS.0004 服务未开通。 404 VIS.0005 请求参数不合法。 403 VIS.0006 无操作权限。 500 VIS.0007 服务内部错误。 503 VIS.0008 依赖的外部服务不可用。 503 VIS.0009 查询IAM凭证异常。 404 VIS.0010 对VIS的委托不存在。 503 VIS.0011 向IAM查询委托权限失败。 404 VIS.0012 对VIS的委托权限不符合要求。 500 VIS.0013 对VIS创建委托失败。 400 VIS.0014 创建资源数量已超过规格限制。 404 VIS.0015 未找到用户注册信息。 403 VIS.0016 用户未申请公测，无法使用服务。 403 VIS.0017 无法访问OBS数据（如：OBS桶未授权）。 400 VIS.0018 用户已经开通过服务。 500 VIS.0019 委托配额超限。 400 VIS.0020 租户缺少OBS项目MOS。 403 VIS.0021 缺少访问权限，请向企业管理员申请。 409 VIS.0022 添加失败，项目ID已经存在。 404 VIS.0023 删除失败，项目ID不存在。 403 VIS.0024 租户状态错误，租户受限或冻结。凭证管理错误（区间101～200） 409 VIS.0101 GB28181凭证的用户名已存在。 404 VIS.0102 GB28181凭证的用户名不存在。 409 VIS.0103 密钥名称已存在。 404 VIS.0104 密钥的AK不存在。 400 VIS.0105 密码不能与用户名或用户名的倒序相同。 403 VIS.0106 原密码不正确，不能更新密码。 400 VIS.0107 密钥正在被视频流使用，不能够删除。 400 VIS.0108 GB28181凭证正在被设备使用，不能删除。 400 VIS.0109 使用该GB28181的某些设备在处于邀约成功状态，不能修改密码。视频流管理类错误（区间201～300） 409 VIS.0201 视频流名称已存在。 400 VIS.0202 视频流ID不存在。 400 VIS.0203 视频流正在删除中，无法操作。 400 VIS.0204 视频流未激活，无法获取Endpoint。 400 VIS.0205 正在转储中，无法更改转储信息。 400 VIS.0206 视频流激活中，无法更改视频接入类型。 400 VIS.0207 输入的url无效，无法拉取视频流。 400 VIS.0208 委托无效，请先授予VIS操作OBS的权限。 400 VIS.0209 OBS路径无效。 403 VIS.0210 没有权限操作OBS桶。 400 VIS.0211 视频流没有在推流。 400 VIS.0212 视频流地址无法连通。 400 VIS.0213 不支持H265编码类型。 400 VIS.0214 该视频流未转储，无法获取转储视频流。 400 VIS.0215 获取转储视频列表参数错误，开始时间和结束时间间隔不能超过7天。 400 VIS.0216 获取转储视频列表参数错误，开始时间不能大于等于结束时间。 400 VIS.0217 OBS服务异常设备管理类错误（区间301～400） 409 VIS.0301 设备ID已存在，无法创建。 404 VIS.0302 没找到指定的设备。 400 VIS.0303 不能删除已经注册的设备。 404 VIS.0304 没找到指定的通道。 500 VIS.0305 激活通道关联的视频流失败。 500 VIS.0306 释放通道关联的视频流失败。 400 VIS.0307 不能删除已经注册的通道。 400 VIS.0308 通道已经处于视频邀约中，或者已经下线。 400 VIS.0309 通道已经处于未邀约状态。 400 VIS.0310 通道接入状态已经激活，不能手动进行视频邀约或取消邀约。 400 VIS.0311 NVR设备通道列表更新中，或者设备不是NVR设备，不能再次刷新。 400 VIS.0312 NVR设备未被成功注册或者已经掉线，不能更新。 400 VIS.0313 NVR设备不能进行TCP优先配置。 400 VIS.0314 不能删除未离线的设备。 400 VIS.0315 通道尚未处于邀约成功的状态。 400 VIS.0316 TCP探测结果不正确。 400 VIS.0317 通道处于下线状态（NVR通道）。 400 VIS.0318 不能删除邀约中的设备。父主题：附录

视频接入服务 VIS

视频接入服务 VIS-开通服务:响应参数

响应参数状态码： 201 表3 响应Body参数参数参数类型描述 user_id String 用户ID。 sip_ip String SIP服务器地址，VIS对外提供的设备注册地址。 sip_port String SIP服务器端口，VIS对外提供的设备注册端口，固定为5080。 quota quotaInfo object 开通服务返回的quota体。 created_at String 创建时间，格式为：YYYY-MM-DDTHH:MM:SSZ（UTC时间）。 is_subscribed Boolean 用户是否开通服务。 true：表示开通。 false：表示未开通。表4 quotaInfo 参数参数类型描述 password PassWordInfo object GB/T28181凭证配额信息。 consecutive_access_time Consecutive_Access_TimeInfo object GB/T28181设备连续接入时长的配额信息。 random_access_time Random_Access_TimeInfo object GB/T28181设备随机接入时长的配额信息。 stream StreamInfo object 视频流配额信息。 active_stream Active_StreamInfo object 激活视频流配额信息。 device DeviceInfo object 设备配额信息。 aksk AKSKInfo object AKSK凭证配额信息。 http_num HttpInfo object http_flv配额信息。 http_active_num HttpActiveInfo object http_flv激活配额信息。 rtmp_num RtmpInfo object rtmp配额信息。表5 PassWordInfo 参数参数类型描述 total Integer GB/T28181凭证总配额量。 used Integer GB/T28181凭证已创建量。表6 Consecutive_Access_TimeInfo 参数参数类型描述 total Integer 设备连续接入的总时长。 used Integer 设备已使用的时长。表7 Random_Access_TimeInfo 参数参数类型描述 total Integer GB/T28181设备随机接入的总时长。 used Integer GB/T28181设备随机已接入的时长。表8 StreamInfo 参数参数类型描述 total Integer 视频流总配额量。 used Integer 视频流已创建量。表9 Active_StreamInfo 参数参数类型描述 total Integer 可激活视频流总配额量。 used Integer 视频流已激活量。表10 DeviceInfo 参数参数类型描述 total Integer 设备总配额量。 used Integer 设备已创建量。表11 AKSKInfo 参数参数类型描述 total Integer AKSK凭证总配额量。 used Integer AKSK凭证已创建量。表12 HttpInfo 参数参数类型描述 total Integer http_flv总配额数量。 used Integer http_flv已创建数量。表13 HttpActiveInfo 参数参数类型描述 total Integer http_flv激活总配额数量。 used Integer http_flv已激活数量。表14 RtmpInfo 参数参数类型描述 total Integer rtmp总配额数量。 used Integer rtmp已创建数量。

视频接入服务 VIS

视频接入服务 VIS-开通服务:响应示例

响应示例状态码： 201 正常 { "user_id" : "******6045184a8194e021113e******", "sip_ip" : "10.95.144.***", "sip_port" : "5080", "quota" : { "consecutive_access_time" : { "total" : 120, "used" : 0 }, "password" : { "total" : 10, "used" : 0 }, "random_access_time" : { "total" : 240, "used" : 0 }, "stream" : { "total" : 50, "used" : 0 }, "active_stream" : { "total" : 10, "used" : 0 }, "device" : { "total" : 50, "used" : 0 }, "aksk" : { "total" : 10, "used" : 0 }, "http_num" : { "total" : 10, "used" : 0 }, "http_active_num" : { "total" : 5, "used" : 0 }, "rtmp_num" : { "total" : 0, "used" : 0 } }, "created_at" : "2018-10-25T03:06:10Z", "is_subscribed" : true} 状态码： 400 请求错误。具体返回错误码请参考错误码说明。 { "error_msg" : "You have already subscribed to VIS.", "error_code" : "VIS.0018"}

视频接入服务 VIS

视频接入服务 VIS-开通服务:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息。

视频接入服务 VIS

视频接入服务 VIS-获取服务开通信息:响应示例

响应示例状态码： 200 正常 { "user_id" : "******6045184a8194e021113e******", "sip_ip" : "10.95.144.***", "sip_port" : "5080", "quota" : { "consecutive_access_time" : { "total" : 120, "used" : 120 }, "password" : { "total" : 10, "used" : 2 }, "random_access_time" : { "total" : 240, "used" : 240 }, "stream" : { "total" : 500, "used" : 8 }, "active_stream" : { "total" : 200, "used" : 4 }, "device" : { "total" : 500, "used" : 0 }, "aksk" : { "total" : 10, "used" : 6 }, "http_num" : { "total" : 10, "used" : 5 }, "http_active_num" : { "total" : 5, "used" : 1 }, "rtmp_num" : { "total" : 0, "used" : 0 } }, "created_at" : "2018-10-25T03:06:10Z", "is_subscribed" : true} 状态码： 404 找不到资源或没有开通服务。具体返回错误码请参考错误码说明。 { "error_msg" : "Failed to find the user subscription info.", "error_code" : "VIS.0015"}

视频接入服务 VIS 服务开通管理

云服务器内容精选

视频接入服务 VIS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线