Liveness Session Operations - Get Liveness Sessions

서비스:

Azure AI Services

API 버전:

v1.2-preview.1

/detectLiveness/SingleModal에 대한 세션을 나열합니다.
'start'보다 큰 마지막 sessionId의 세션을 나열합니다.

결과는 sessionId를 오름차순으로 정렬해야 합니다.

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions

선택적 매개 변수:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions?start={start}&top={top}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiVersion	path	True	string	API 버전
endpoint	path	True	string uri	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	"start"보다 큰 리소스를 나열합니다. 64자를 넘지 않습니다. 기본값은 비어 있습니다.
top	query		integer int32	나열할 항목 수([1, 1000])입니다. 기본값은 1000입니다.

응답

Name	형식	Description
200 OK	LivenessSessionItem[]	요청이 성공했습니다.
Other Status Codes	FaceErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

Azure AI Face 구독의 비밀 키입니다.

형식: apiKey
In(다음 안에): header

AADToken

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: accessCode
권한 부여 URL: https://api.example.com/oauth2/authorize
토큰 URL: https://api.example.com/oauth2/token

범위

Name	Description
https://cognitiveservices.azure.com/.default

예제

Get LivenessSessions

샘플 요청

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

샘플 응답

상태 코드:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

정의

Name	Description
FaceError	오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	오류 세부 정보가 포함된 응답입니다.
LivenessSessionItem	열거를 위해 반환된 세션 데이터입니다.

FaceError

오류 개체입니다. Face Service에서 반환된 오류 코드 및 메시지에 대한 포괄적인 세부 정보는 다음 링크를 참조하세요. https://aka.ms/face-error-codes-and-messages.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

FaceErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	FaceError	오류 개체입니다.

LivenessSessionItem

열거를 위해 반환된 세션 데이터입니다.

Name	형식	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	세션이 지속되어야 하는 시간(초)입니다. 범위는 60~86400초입니다. 기본값은 600입니다.
createdDateTime	string		이 세션이 만들어진 날짜/시간입니다.
deviceCorrelationId	string		각 최종 사용자 디바이스당 고유 Guid입니다. 이는 속도 제한 및 망치 방지를 제공하기 위한 것입니다. 이 요청에서 'deviceCorrelationIdSetInClient'가 true이면 이 'deviceCorrelationId'는 null이어야 합니다.
id	string		이 세션을 참조할 고유 ID입니다.
sessionExpired	boolean		세션이 만료되었는지 여부입니다.
sessionStartDateTime	string		클라이언트가 이 세션을 시작한 DateTime입니다.