기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
StartEdgeConfigurationUpdateAPI를 사용하여 설정된 스트림의 에지 구성과 Edge Agent의 레코더 및 업로더 작업의 최신 상태를 설명합니다. 이 API를 사용하여 구성 상태를 가져와 구성이 Edge Agent와 동기화되어 있는지 확인할 수 있습니다. 이 API를 사용하여 에지 에이전트의 상태를 평가하십시오.
참고
이 API는 AWS 아프리카 (케이프타운) 지역인 af-south-1에서는 사용할 수 없습니다.
Request Syntax
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]+Required: No
- StreamName
-
에지 구성을 업데이트하려는 스트림의 이름.
StreamName또는 를 지정합니다StreamARN.유형: 문자열
길이 제약 조건: 최소 길이는 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
-
Edge Agent의 레코더 및 업로더 작업에 대한 최신 상태 세부 정보가 포함된 객체입니다. 이 정보를 사용하여 Edge Agent의 현재 상태를 확인할 수 있습니다.
유형: EdgeAgentStatus객체
- EdgeConfig
-
Edge Agent IoT Greengrass 구성 요소와 동기화하는 데 사용할 스트림의 에지 구성에 대한 설명입니다. Edge Agent 구성 요소는 온프레미스의 IoT Hub 장치 설정에서 실행됩니다.
유형: 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
Errors
모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- AccessDeniedException
-
이 작업을 수행하는 데 필요한 권한이 없습니다.
HTTP 상태 코드: 401
- ClientLimitExceededException
-
허용된 클라이언트 호출 한도를 초과했기 때문에 Kinesis Video Streams가 요청 병목 현상을 일으켰습니다. 나중에 전화를 걸어 보세요.
HTTP 상태 코드: 400
- InvalidArgumentException
-
이 입력 매개변수의 값이 유효하지 않습니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams에서 지정한 스트림을 찾을 수 없습니다.
HTTP 상태 코드: 404
- StreamEdgeConfigurationNotFoundException
-
Amazon Kinesis Video Stream이 지정한 스트림의 엣지 구성을 찾을 수 없는 경우 예외가 렌더링됩니다.
HTTP 상태 코드: 404
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
