GetIceServerConfig - Amazon Kinesis Video Streams
Request SyntaxURI 요청 파라미터요청 본문응답 구문응답 요소Errors참고

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

GetIceServerConfig

참고: 이 API를 사용하기 전에 API를 호출하여 HTTPS 엔드포인트를 요청해야 합니다. GetSignalingChannelEndpoint 그런 다음 GetIceServerConfig API 요청에서 엔드포인트와 리전을 지정합니다.

WebRTC 연결을 구성하는 데 사용할 수 있는 URI, 사용자 이름 및 암호를 포함한 ICE (대화형 연결 설정) 서버 구성 정보를 가져옵니다. ICE 구성 요소는 이 구성 정보를 사용하여 NAT (TURN) 릴레이 주변의 Traversal Using Relays를 통한 인증을 포함하여 WebRTC 연결을 설정합니다.

TURN은 애플리케이션의 연결성을 개선하는 데 사용되는 프로토콜입니다. peer-to-peer TURN은 클라우드 기반 릴레이 서비스를 제공함으로써 한 명 이상의 피어가 직접 연결을 할 수 없는 경우에도 연결을 설정할 수 있도록 합니다. peer-to-peer 자세한 내용은 TURN 서비스 액세스를 위한 REST API를 참조하십시오.

피어 중 한 명이 신호 채널을 통해 직접 peer-to-peer 연결을 설정할 수 없는 경우 이 API를 호출하여 대체 메커니즘을 설정할 수 있습니다. 이 API를 호출하려면 신호 채널의 Amazon 리소스 이름 (ARN) 을 지정해야 합니다.

Request Syntax

POST /v1/get-ice-server-config HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "ClientId": "string",
   "Service": "string",
   "Username": "string"
}

URI 요청 파라미터

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

요청 본문

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

ChannelARN

구성된 피어 간 peer-to-peer 연결에 사용할 신호 채널의 ARN입니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이는 1024입니다.

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

필수 사항 여부: Yes

ClientId

시청자의 고유 식별자. 신호 채널 내에서 고유해야 합니다.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

패턴: [a-zA-Z0-9_.-]+

Required: No

Service

원하는 서비스를 지정합니다. 현재는 TURN 이 (가) 유일한 유효한 값입니다.

타입: 문자열

유효 값: TURN

필수 여부: 아니요

Username

자격 증명에 연결할 선택적 사용자 ID.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

패턴: [a-zA-Z0-9_.-]+

필수 여부: 아니요

응답 구문

HTTP/1.1 200
Content-type: application/json

{
   "IceServerList": [ 
      { 
         "Password": "string",
         "Ttl": number,
         "Uris": [ "string" ],
         "Username": "string"
      }
   ]
}

응답 요소

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

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

IceServerList

ICE 서버 정보 개체 목록.

타입: IceServer 객체 배열

Errors

모든 작업에서 발생하는 일반적인 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.

ClientLimitExceededException

허용된 클라이언트 호출 한도를 초과했기 때문에 요청이 병목 현상이 발생했습니다. 나중에 전화를 걸어 보세요.

HTTP 상태 코드: 400

InvalidArgumentException

이 입력 매개변수의 값이 유효하지 않습니다.

HTTP 상태 코드: 400

InvalidClientException

지정된 클라이언트가 유효하지 않습니다.

HTTP 상태 코드: 400

NotAuthorizedException

발신자는 이 작업을 수행할 권한이 없습니다.

HTTP 상태 코드: 401

ResourceNotFoundException

지정된 리소스를 찾을 수 없습니다.

HTTP 상태 코드: 404

SessionExpiredException

클라이언트 세션이 만료된 경우 클라이언트가 연결되면 세션은 45분 동안 유효합니다. 메시지를 계속 보내고 받으려면 클라이언트가 채널에 다시 연결해야 합니다.

HTTP 상태 코드: 400

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.