DescribeEdgeConfiguration - Amazon Kinesis Video Streams

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

DescribeEdgeConfiguration

描述使用 StartEdgeConfigurationUpdate API 设置的直播边缘配置以及边缘代理录制器和上传者作业的最新状态。使用此 API 获取配置状态,以确定配置是否与 Edge Agent 同步。使用此 API 来评估边缘代理的运行状况。

注意

此 API 不在 AWS 非洲(开普敦)区域 af-south-1 中提供。

请求语法

POST /describeEdgeConfiguration HTTP/1.1 Content-type: application/json { "StreamARN": "string", "StreamName": "string" }

URI 请求参数

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

请求体

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

StreamARN

流的 Amazon 资源名称(ARN)。指定StreamNameStreamARN

类型:字符串

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

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

必需:否

StreamName

要更新其边缘配置的直播的名称。指定StreamNameStreamARN

类型:字符串

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

模式:[a-zA-Z0-9_.-]+

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "EdgeAgentStatus": { "LastRecorderStatus": { "JobStatusDetails": "string", "LastCollectedTime": number, "LastUpdatedTime": number, "RecorderStatus": "string" }, "LastUploaderStatus": { "JobStatusDetails": "string", "LastCollectedTime": number, "LastUpdatedTime": number, "UploaderStatus": "string" } }, "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

首次创建直播边缘配置的时间戳。

类型:时间戳

EdgeAgentStatus

一个对象,其中包含边缘代理的录制器和上传者作业的最新状态详细信息。使用此信息来确定边缘代理的当前运行状况。

类型:EdgeAgentStatus 对象

EdgeConfig

对直播边缘配置的描述,该配置将用于与 Edge Agent IoT Greengrass 组件同步。Edge Agent 组件将在您所在地的 IoT 中心设备设置上运行。

类型:EdgeConfig 对象

FailedStatusDetails

对生成的故障状态的描述。

类型:字符串

LastUpdatedTime

上次更新直播边缘配置的时间戳。

类型:时间戳

StreamARN

流的 Amazon 资源名称(ARN)。

类型:字符串

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

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

StreamName

更新边缘配置的流的名称。

类型:字符串

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

模式:[a-zA-Z0-9_.-]+

SyncStatus

边缘配置更新的最新状态。

类型:字符串

有效值:SYNCING | ACKNOWLEDGED | IN_SYNC | SYNC_FAILED | DELETING | DELETE_FAILED | DELETING_ACKNOWLEDGED

错误

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

AccessDeniedException

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

HTTP 状态代码:401

ClientLimitExceededException

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

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

ResourceNotFoundException

亚马逊 Kinesis Video Streams 找不到你指定的直播。

HTTP 状态代码:404

StreamEdgeConfigurationNotFoundException

当 Amazon Kinesis 视频流找不到您指定的直播边缘配置时,会呈现异常。

HTTP 状态代码:404

另请参阅

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