AWS IoT SiteWise 엣지 디바이스와 함께 사용하기 위한 엣지 전용 API

엣지에서 사용할 수 있는 AWS IoT SiteWise API 외에도 엣지별 API도 있습니다. 이러한 엣지별 API가 아래에 설명되어 있습니다.

인증

SiteWise Edge 게이트웨이에서 자격 증명을 가져옵니다. 로컬 사용자를 추가하거나 LDAP 또는 Linux 사용자 풀을 사용하여 시스템에 연결해야 합니다. 사용자 추가에 대한 자세한 내용은 LDAP 또는 Linux 사용자 풀을 참조하십시오.

요청 구문

POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}

URI 요청 파라미터

요청은 URI 파라미터를 사용하지 않습니다.

요청 본문

요청은 JSON 형식으로 다음 데이터를 받습니다.

사용자 이름

요청 호출을 검증하는 데 사용되는 사용자 이름입니다.

유형: 문자열

필수 항목 여부: 예

비밀번호

보안 인증을 요청하는 사용자의 비밀번호입니다.

유형: 문자열

필수 항목 여부: 예

authMechanism

호스트에서 이 사용자의 유효성을 검사하기 위한 인증 방법입니다.

유형: 문자열

유효한 값: ldap, linux, winnt

필수 항목 여부: 예

응답 구문

HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 JSON 형식으로 반환됩니다.

accessKeyId

임시 보안 인증 정보를 식별하는 액세스 키 ID입니다.

길이 제약: 최소 길이는 16입니다. 최대 길이 128.

패턴: [\w]*

secretAccessKey

요청에 서명하는 데 사용되는 비밀 액세스 키입니다.

유형: 문자열

sessionToken

사용자가 임시 보안 인증을 사용하기 위해 서비스 API에 전달해야 하는 토큰입니다.

유형: 문자열

region

API 직접 호출 대상 지역입니다.

유형: CONSTANT - edge

Errors

IllegalArgumentException

제공된 본문 문서의 형식이 잘못되어 요청이 거부되었습니다. 오류 메시지에 특정 오류가 설명되어 있습니다.

HTTP 상태 코드: 400

AccessDeniedException

사용자는 현재 ID 제공자에 기반한 유효한 보안 인증을 가지고 있지 않습니다. 오류 메시지에 인증 메커니즘이 설명되어 있습니다.

HTTP 상태 코드: 403

TooManyRequestsException

요청이 인증 시도 한도에 도달했습니다. 오류 메시지에는 인증을 새로 시도할 때까지 기다려야 하는 시간이 포함됩니다.

HTTP Status Code: 429