本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
UpdateDataRetention
按您指定的值增加或减少数据流的数据保留期。要指明是要延长还是缩短数据保留期,请在请求正文中指定Operation
参数。在请求中,必须指定StreamName
或StreamARN
。
注意
您指定的保留期取代当前值。
此操作需要 KinesisVideo:UpdateDataRetention
操作权限。
更改数据保留期会影响流中的数据,如下所示:
-
如果延长数据保留期,则将在新的保留期内保留现有数据。例如,如果数据保留期从一小时增加到七小时,则所有现有数据将保留七个小时。
-
如果缩短数据保留期,则将在新的保留期内保留现有数据。例如,如果数据保留期从七小时缩短到一小时,则所有现有数据将保留一小时,并且任何超过一小时的数据都将立即删除。
请求语法
POST /updateDataRetention HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string
",
"DataRetentionChangeInHours": number
,
"Operation": "string
",
"StreamARN": "string
",
"StreamName": "string
"
}
URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- CurrentVersion
-
要更改其保留期的流的 Amazon 的 Amazon 版本。要获取版本,请调用
DescribeStream
或ListStreams
API。类型:字符串
长度限制:最小长度为 1。最大长度为 64。
模式:
[a-zA-Z0-9]+
必需:是
- DataRetentionChangeInHours
-
保留期,以小时为单位。您指定的值替换当前值。此参数的最大值为 87600(十年)。
类型:整数
有效范围:最小值为 1。
必需:是
- Operation
-
指示要延长还是缩短保留期。
类型:字符串
有效值:
INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION
必需:是
- StreamARN
-
要更改其保留期的流的 Amazon 资源名称(ARN)。
类型:字符串
长度限制:最小长度为 1。长度上限为 1024。
模式:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
必需:否
- StreamName
-
要更改其保留期的流的 Amazon 的名称。
类型:字符串
长度限制:最小长度为 1。长度上限为 256。
模式:
[a-zA-Z0-9_.-]+
必需:否
响应语法
HTTP/1.1 200
响应元素
如果此操作成功,则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。
错误
有关所有操作常见错误的信息,请参阅常见错误。
- ClientLimitExceededException
-
Kinesis Video Streams 限制了该请求,因为您已超过允许的客户端呼叫限制。稍后再试打电话。
HTTP 状态代码:400
- InvalidArgumentException
-
此输入参数的值无效。
HTTP 状态代码:400
- NotAuthorizedException
-
呼叫者没有权限执行此操作。
HTTP 状态代码:401
- ResourceInUseException
-
当输入
StreamARN
或ChannelARN
输入已映射到不同CLOUD_STORAGE_MODE
的 Kinesis Video Stream 资源,或者提供的输入StreamARN
或未ChannelARN
处于活动状态时,请尝试以下操作之一:-
用于确定给定频道映射到什么的
DescribeMediaStorageConfiguration
API。 -
用于确定给定流映射到的频道的
DescribeMappedResourceConfiguration
API。 -
DescribeSignalingChannel
用于确定资源状态的DescribeStream
或 API。
HTTP 状态代码:400
-
- ResourceNotFoundException
-
Amazon Kinesis Video Streams reams 找不到你指定的直播。
HTTP 状态代码:404
- VersionMismatchException
-
您指定的直播版本不是最新版本。要获取最新版本,请使用 DescribeStreamAPI。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: