ConnectAsViewer - Kinesis Video Streams
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ConnectAsViewer

以查看器身份连接到由终端节点指定的信令通道。任何 WebSocket兼容的库都可用于连接到从 GetSignalingChannelEndpoint API 调用中获得的安全 websocket (WSS) 端点。信令通道的 Amazon 资源名称 (ARN) 和客户端 ID 必须作为查询字符串参数提供。有单独的终端节点可用于作为主设备和查看器进行连接。如果存在与请求指定的 ClientId 相同的现有连接,则新连接优先。新信息将覆盖连接元数据。

请求

"X-Amz-ChannelARN": "string", "X-Amz-ClientId": "string"
  • X-Amz-ChannelARN - 信令通道的 ARN。

    • 类型:字符串

    • 长度限制:最小长度为 1。最大长度为 1024

    • 模式:arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

    • 必需:是

  • X-Amz-ClientId-客户端的唯一标识符。

    • 类型:字符串

    • 长度限制:最小长度为 1。最大长度为 256。

    • 模式:^(?!(?i)AWS_.*)[a-zA-Z0-9_.-]

      注意

      X-Amz-ClientId一开始不行AWS_

    • 必需:是

响应

200 OK HTTP 状态代码以及一个空正文。

错误

  • InvalidArgumentException

    指定的参数超出其限制、不受支持或无法使用。有关更多信息,请参阅返回的消息。

    HTTP 状态代码:400

  • AccessDeniedException

    未授权调用方访问给定的通道或令牌已过期。

    HTTP 状态代码:403

  • ResourceNotFoundException

    通道不存在。

    HTTP 状态代码:404

  • ClientLimitExceededException

    当以过高的速率调用 API 时,或者连接到通道的查看器数量超过支持的最大数量时。有关更多信息,请参阅带有 WebRTC 服务配额的亚马逊 Kinesis Video Streams和中的错误重试和指数回退。 Amazon

    HTTP 状态代码:400

局限/限制

如果以过高的速率调用该 API,或当连接到该通道的查看器数量超过支持的最大数量时,会在账户级别限制该 API。受到限制时返回错误以及 ClientLimitExceededException

幂等

如果指定的 ClientId 和通道已存在连接,则使用新信息更新连接元数据。

重试行为

这被视为新的 API 调用。

并发调用

允许并发调用,对于每个调用都会更新连接元数据。