UpdateSignalingChannel - Amazon Kinesis Video Streams
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅

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

UpdateSignalingChannel

更新现有的信令信道。这是一个异步操作，需要一段时间才能完成。

如果该MessageTtlSeconds值已更新（增加或减少），则仅适用于更新后通过此渠道发送的新消息。根据之前的MessageTtlSeconds值，现有消息仍过期。

请求语法

POST /updateSignalingChannel HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "CurrentVersion": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   }
}

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

ChannelARN

您要更新的信令通道的 Amazon 资源名称 (ARN)。

类型：字符串

长度限制：长度下限为 1。长度上限为 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必需：是

CurrentVersion

您要更新的信令通道的当前版本。

类型：字符串

长度限制：长度下限为 1。长度上限为 64。

模式：[a-zA-Z0-9]+

必需：是

SingleMasterConfiguration

包含要更新的信令信道SINGLE_MASTER类型的配置的结构。

类型：SingleMasterConfiguration 对象

必需：否

响应语法

HTTP/1.1 200

响应元素

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

错误

有关所有操作的常见错误信息，请参阅常见错误。

AccessDeniedException

您没有执行此操作所需的权限。

HTTP 状态代码：401

ClientLimitExceededException

Kinesis Video Streams 已限制该请求，因为你已超过允许的客户端调用限制。稍后再尝试拨打电话。

HTTP 状态代码：400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码：400

ResourceInUseException

如果输入StreamARN或ChannelARN输入已映射到其他 Kinesis Video Stream 资源，或者提供的输入StreamARN或未ChannelARN处于 “活动” 状态，请尝试以下方法之一：CLOUD_STORAGE_MODE

  1. 用于确定给定频道的直播映射到什么的 DescribeMediaStorageConfiguration API。

  2. 用于确定给定直播映射到哪个频道的 DescribeMappedResourceConfiguration API。

  3. DescribeStream或 DescribeSignalingChannel API，用于确定资源状态。

HTTP 状态代码：400

ResourceNotFoundException

Amazon Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码：404

VersionMismatchException

您指定的直播版本不是最新版本。要获取最新版本，请使用 DescribeStreamAPI。

HTTP 状态代码：400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：