ConnectAsMaster - Kinesis Video Streams

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

ConnectAsMaster

以主设备的身份连接到由终端节点指定的信令通道。任何符合 WebSocket 的库均可用于连接到从 GetSignalingChannelEndpoint API 调用获得的终端节点。信令通道的 Amazon 资源名称 (ARN) 必须作为查询字符串参数提供。有单独的终端节点可用于作为主设备和查看器进行连接。如果多个客户端作为主设备连接到特定通道,则最近的请求优先。新的连接元数据将覆盖现有连接元数据。

请求

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

    • 类型:字符串

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

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

    • 必需:是

响应

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

错误

  • InvalidArgumentException

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

    HTTP 状态代码:400

  • AccessDeniedException

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

    HTTP 状态代码:403

  • ResourceNotFoundException

    通道不存在。

    HTTP 状态代码:404

  • ClientLimitExceededException

    当以过高的速率调用 API 时。有关更多信息,请参阅 AWS中的 Amazon Kinesis Video Streams with WebRTC 服务限额错误重试和指数回退。

    HTTP 状态代码:400

局限/限制

如果以过高的速率调用 API,此 API 将在账户级别受到限制。受到限制时返回错误以及 ClientLimitExceededException

幂等

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

重试行为

这被视为新的 API 调用。

并发调用

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