本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # StartEdgeConfigurationUpdate 一种异步 API，用于更新直播的现有边缘配置。Kinesis Video Stream 会将直播的边缘配置与在你所在地设置的物联网中心设备上运行的 Edge Agent IoT Greengrass 组件同步。同步的时间可能有所不同，具体取决于集线器设备的连接。`SyncStatus`将在确认边缘配置后进行更新，并与 Edge Agent 同步。如果首次调用此 API，则将为该直播创建新的边缘配置，并将同步状态设置为`SYNCING`。在再次使用此 API 之前，您必须等待同步状态达到终端状态`SYNC_FAILED`，例如:`IN_SYNC`、或。如果您在同步过程中调用此 API，则`ResourceInUseException`会抛出。将重试直播的边缘配置和 Edge Agent 的连接，持续 15 分钟。15 分钟后，状态将变为`SYNC_FAILED`状态。要将边缘配置从一台设备移动到另一台设备，请使用[DeleteEdgeConfiguration](API_DeleteEdgeConfiguration.md)删除当前的边缘配置。然后，您可以使用更新的中心设备 ARN StartEdgeConfigurationUpdate 进行调用。 **注意** 此 API 不在 AWS 非洲（开普敦）区域 af-south-1 中提供。 ## 请求语法 ``` POST /startEdgeConfigurationUpdate HTTP/1.1 Content-type: application/json { "EdgeConfig": { "DeletionConfig": { "DeleteAfterUpload": boolean, "EdgeRetentionInHours": number, "LocalSizeConfig": { "MaxLocalMediaSizeInMB": number, "StrategyOnFullSize": "string" } }, "HubDeviceArn": "string", "RecorderConfig": { "MediaSourceConfig": { "MediaUriSecretArn": "string", "MediaUriType": "string" }, "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } }, "UploaderConfig": { "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } } }, "StreamARN": "string", "StreamName": "string" } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 调用更新过程所需的边缘配置详细信息。类型：[EdgeConfig](API_EdgeConfig.md) 对象是否必需：是 ** [StreamARN](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 流的 Amazon 资源名称（ARN）。指定`StreamName`或`StreamARN`。类型：字符串长度限制：最小长度为 1。长度上限为 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` 必需：否 ** [StreamName](#API_StartEdgeConfigurationUpdate_RequestSyntax) ** 要更新其边缘配置的直播的名称。指定`StreamName`或`StreamARN`。类型：字符串长度限制：最小长度为 1。最大长度为 256。模式：`[a-zA-Z0-9_.-]+` 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "EdgeConfig": { "DeletionConfig": { "DeleteAfterUpload": boolean, "EdgeRetentionInHours": number, "LocalSizeConfig": { "MaxLocalMediaSizeInMB": number, "StrategyOnFullSize": "string" } }, "HubDeviceArn": "string", "RecorderConfig": { "MediaSourceConfig": { "MediaUriSecretArn": "string", "MediaUriType": "string" }, "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } }, "UploaderConfig": { "ScheduleConfig": { "DurationInSeconds": number, "ScheduleExpression": "string" } } }, "FailedStatusDetails": "string", "LastUpdatedTime": number, "StreamARN": "string", "StreamName": "string", "SyncStatus": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [CreationTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 首次创建直播边缘配置的时间戳。类型：时间戳 ** [EdgeConfig](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 对直播边缘配置的描述，该配置将用于与 Edge Agent IoT Greengrass 组件同步。Edge Agent 组件将在您所在地的 IoT 中心设备设置上运行。类型：[EdgeConfig](API_EdgeConfig.md) 对象 ** [FailedStatusDetails](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 对生成的故障状态的描述。类型：字符串 ** [LastUpdatedTime](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 上次更新直播边缘配置的时间戳。类型：时间戳 ** [StreamARN](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 流的 Amazon 资源名称（ARN）。类型：字符串长度限制：最小长度为 1。长度上限为 1024。模式：`arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` ** [StreamName](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 从中更新 Edge 配置的流的名称。类型：字符串长度限制：最小长度为 1。最大长度为 256。模式：`[a-zA-Z0-9_.-]+` ** [SyncStatus](#API_StartEdgeConfigurationUpdate_ResponseSyntax) ** 直播边缘配置的当前同步状态。当您调用此 API 时，同步状态将设置为`SYNCING`状态。使用 `DescribeEdgeConfiguration` API 获取边缘配置的最新状态。类型：字符串有效值：`SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。 ** AccessDeniedException ** 您没有执行此操作所需的权限。 HTTP 状态代码：401 ** ClientLimitExceededException ** Kinesis Video Streams 已限制该请求，因为你已超过允许的客户端调用限制。稍后再尝试拨打电话。 HTTP 状态代码：400 ** InvalidArgumentException ** 此输入参数的值无效。 HTTP 状态代码：400 ** NoDataRetentionException ** 流数据保留时间（以小时为单位）等于零。 HTTP 状态代码：400 ** ResourceInUseException ** 如果输入`StreamARN`或`ChannelARN`输入已映射到其他 Kinesis Video Stream 资源，或者所提供的输入`StreamARN`或未`ChannelARN`处于 “活动” 状态，请尝试以下方法之一：`CLOUD_STORAGE_MODE` 1. 用于确定给定频道的直播映射到什么的 `DescribeMediaStorageConfiguration` API。 1. 用于确定给定直播映射到哪个频道的 `DescribeMappedResourceConfiguration` API。 1. `DescribeStream`或 `DescribeSignalingChannel` API，用于确定资源状态。 HTTP 状态代码：400 ** ResourceNotFoundException ** Amazon Kinesis Video Streams 找不到你指定的直播。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate)