检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme}
状态码 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 表1 公共响应消息头
存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要
错误码 调用API出错后，将不会返回结果数据。调用方可根据每个API对应的错误码来定位错误原因。当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系客服，并提供错误码，以便我们尽快帮您解决问题。
在项目列表中查看项目ID。 图1 查看账号ID/项目ID 单击“管理访问密钥”，可以查看已添加的访问密钥ID（Access Key ID，AK）。 如果没有AK/SK，可单击“新增访问密钥”来添加。 如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials
由于重新邀约后取流地址会发生改变，因此您在进行推流或拉流前，需在控制台的“视频预览”页面中获取最新的流信息，确保使用的是最新的视频流地址。您也可以通过调用获取视频流地址接口获取最新的视频流地址。
终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 视频接入服务的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 视频接入服务终端节点 区域名称 区域 终端节点（Endpoint）
视频数据不会保存。更新转储信息后可以将视频流保存到指定的存储媒介，如OBS。后续用户可以从OBS上获取到转储的视频。 如果转储到OBS，在调用该API之前，需要您先授予VIS操作OBS的权限，授权操作只需要操作一次即可，后续转储无需再操作。授权方法如下： 登录视频接入服务控制台。
间以系统为准。 具体计费价格请参见视频接入价格详情。 续费 按需资源不可续费，您仅需要保持账户余额充足即可。 到期与欠费 到期欠费后，可以查看欠费详情。视频接入服务的所有资源（含视频流、设备、秘钥等）的创建、更新将被限制，无法使用。为防止相关资源不被停止或者释放，请及时进行充值，
为了使您能够全面的了解设备接入情况，您可以在“设备指标统计”中查看相关状态的设备信息。 操作步骤 登录VIS管理控制台。 选择“指标统计”>“设备指标统计”，查询相关状态的设备信息。 如果需要查询某个具体的设备信息时，可以通过搜索具体的设备ID，直接查看该设备相关信息。 图1 设备指标统计 表1 指标统计状态
在“设备管理”界面，选择目标设备操作列的“更多 > 视频邀约”。 图1 已注册设备 邀约成功后，在“视频流管理”界面可查看已激活的关联视频流，此时设备可以通过该视频流进行推流。 单击视频流名称，可以查看取流地址（GB/T28181设备的视频流只需关注取流地址）。 VIS自动为GB/T28181设备创
的智能分析应用。 视频接入服务给用户提供了开放API的方式，您可以根据本文档提供的API来使用服务，支持的全部API请参见API概览。 在调用视频接入服务API之前，请确保已经充分了解视频接入服务相关概念，详细信息请参见产品介绍。 父主题： 使用前必读
当因网络或其它原因，导致视频流中断后自动恢复时，推流地址或拉流地址可能发生变化。请重新调用该接口，并尝试使用新的推流地址再次进行推流。在灾备场景下，拉流地址可能会发生变化，导致已获取的相应地址无效，请重新调用该接口获取新的地址。 为防止接入视频被泄露和盗链，获取的拉流地址中包含防盗链，防
设备ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表3 响应Body参数
视频转储 如果需要对实时视频流的数据进行保存，供后续分析或查看，可以对视频流进行转储。 对于新创建的视频流，默认是不进行转储的。只有在视频流为“已激活”状态时，才可以对视频流进行转储，当前VIS支持将视频流转储到OBS。 OBS桶授权策略 由于VIS进行转储时需要获取用户的OBS
公共数据结构 列表查询参数（queryOption） 参数 是否必选 类型 说明 offset 否 Integer 查询的开始位置，取值范围为1～100000，必须与limit一起使用。 与limit同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。 如果offset超过数据总条数，则结果返回空列表。
TP-FLV视频流操作列的“激活”。 视频流在激活之后，单击视频流名称，可以查看视频流详情，包括实时视频、拉流地址以及取流地址（HTTP-FLV类型，仅需关注取流地址）。 视频流如果没有激活，则无法查看。 取流地址：用户客户端可以通过该地址，获取该视频流。
视频流创建之后，需要激活才能进行拉流。在“视频流管理”界面，单击RTMP视频流操作列的“激活”。 视频流在激活之后，单击视频流名称，可以查看视频流详情，包括实时视频、推流地址以及取流地址。 视频流如果没有激活，则无法查看。 推流地址：用户客户端可以通过该地址，将客户端的视频流推送到VIS平台。 例如推流地址为“rtmp://10
行视频邀约，视频邀约成功后，设备的视频会持续接入到VIS中，直到取消邀约。 4.视频转储 如果需要对实时视频流的数据进行保存，供后续分析或查看，可以对视频流进行转储。 5.（可选）定时接入 该操作可选，VIS支持用户对已上线的国标摄像头设置定时接入策略。用户可以设置摄像头在一天中
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
