Azure SignalR Service REST API
이 문서의 내용
버전: 2022-06-01
사용 가능한 API
/api/health
HEAD
요약
서비스 상태를 가져옵니다.
서비스 상태 가져오기
HEAD /api/health
매개 변수
속성
위치
설명
필수
스키마
api-version
query
REST API의 버전입니다.
예
string
응답
코드
설명
200
서비스가 정상입니다.
default
오류 응답
/api/hubs/{hub}/:closeConnections
POST
요약
허브의 모든 연결을 닫습니다.
허브에서 모든 연결 닫기
POST /api/hubs/{hub}/:closeConnections
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
제외됨
query
허브에서 연결을 닫을 때 이러한 connectionIds를 제외합니다.
아니요
[ string ]
reason
query
클라이언트 연결을 닫는 이유입니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/:send
POST
요약
메시지를 대상 허브에 연결된 모든 클라이언트에 브로드캐스트합니다.
대상 허브에 연결된 모든 클라이언트에 메시지 브로드캐스트
POST /api/hubs/{hub}/:send
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
제외됨
query
제외된 연결 ID
아니요
[ string ]
api-version
query
REST API의 버전입니다.
예
string
message
body
페이로드 메시지입니다.
예
PayloadMessage
응답
/api/hubs/{hub}/connections/{connectionId}
HEAD
요약
지정된 connectionId와의 연결이 있는지 확인합니다.
지정된 connectionId와의 연결이 있는지 확인합니다.
HEAD /api/hubs/{hub}/connections/{connectionId}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
connectionId
경로
연결 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
DELETE
요약
클라이언트 연결을 닫습니다.
클라이언트 연결을 닫습니다.
DELETE /api/hubs/{hub}/connections/{connectionId}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
connectionId
경로
연결 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
reason
query
연결이 닫히게 된 이유입니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/connections/{connectionId}/:send
POST
요약
메시지를 특정 연결에 보냅니다.
특정 연결에 메시지 보내기
POST /api/hubs/{hub}/connections/{connectionId}/:send
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
connectionId
경로
연결 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
message
body
페이로드 메시지입니다.
예
PayloadMessage
응답
/api/hubs/{hub}/groups/{group}
HEAD
요약
지정된 그룹 내에 클라이언트 연결이 있는지 확인합니다.
지정된 그룹 내에 클라이언트 연결이 있는지 확인합니다.
HEAD /api/hubs/{hub}/groups/{group}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/groups/{group}/:closeConnections
POST
요약
특정 그룹의 연결을 닫습니다.
특정 그룹의 연결 닫기
POST /api/hubs/{hub}/groups/{group}/:closeConnections
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
제외됨
query
허브에서 연결을 닫을 때 이러한 connectionIds를 제외합니다.
아니요
[ string ]
reason
query
클라이언트 연결을 닫는 이유입니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/groups/{group}/:send
POST
요약
대상 그룹 내의 모든 클라이언트에게 메시지를 브로드캐스트합니다.
대상 그룹 내의 모든 클라이언트에 메시지 브로드캐스트
POST /api/hubs/{hub}/groups/{group}/:send
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
제외됨
query
제외된 연결 ID
아니요
[ string ]
api-version
query
REST API의 버전입니다.
예
string
message
body
페이로드 메시지입니다.
예
PayloadMessage
응답
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
요약
연결을 대상 그룹에 추가합니다.
대상 그룹에 연결 추가
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
connectionId
경로
대상 연결 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
DELETE
요약
대상 그룹에서 연결을 제거합니다.
대상 그룹에서 연결 제거
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
connectionId
경로
대상 연결 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
요약
모든 그룹에서 연결 제거
모든 그룹에서 연결 제거
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
connectionId
경로
대상 연결 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/users/{user}
HEAD
요약
지정된 사용자에 대해 연결된 클라이언트 연결이 있는지 확인합니다.
지정된 사용자에 대해 연결된 클라이언트 연결이 있는지 확인합니다.
HEAD /api/hubs/{hub}/users/{user}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
user
경로
사용자 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/users/{user}/:closeConnections
POST
요약
특정 사용자에 대한 연결을 닫습니다.
특정 사용자에 대한 연결 닫기
POST /api/hubs/{hub}/users/{user}/:closeConnections
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
user
경로
사용자 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
제외됨
query
허브에서 연결을 닫을 때 이러한 connectionIds를 제외합니다.
아니요
[ string ]
reason
query
클라이언트 연결을 닫는 이유입니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/users/{user}/:send
POST
요약
메시지를 대상 사용자에게 속한 모든 클라이언트에 브로드캐스트합니다.
대상 사용자에 속한 모든 클라이언트에 메시지 브로드캐스트
POST /api/hubs/{hub}/users/{user}/:send
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
user
경로
사용자 ID입니다.
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
message
body
페이로드 메시지입니다.
예
PayloadMessage
응답
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
요약
사용자가 대상 그룹에 있는지 확인합니다.
사용자가 대상 그룹에 있는지 확인
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
user
경로
대상 사용자 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
PUT
요약
사용자를 대상 그룹에 추가합니다.
대상 그룹에 사용자 추가
PUT /api/hubs/{hub}/users/{user}/groups/{group}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
user
경로
대상 사용자 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
ttl
query
사용자가 그룹에 존재하는 시간(초)을 지정합니다. 설정하지 않으면 사용자는 최대 1년 동안 그룹에 살고 있습니다. 사용자가 ttl 제한 없이 일부 그룹에 추가되는 경우 최신 업데이트된 100개 그룹만 사용자가 TTL 없이 조인한 모든 그룹 간에 예약됩니다. ttl = 0이면 대상 사용자의 현재 연결된 연결만 대상 그룹에 추가됩니다.
아니요
정수
api-version
query
REST API의 버전입니다.
예
string
응답
DELETE
요약
대상 그룹에서 사용자를 제거합니다.
대상 그룹에서 사용자 제거
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
group
경로
대상 그룹 이름입니다. 길이는 0보다 크고 1025보다 작아야 합니다.
예
string
user
경로
대상 사용자 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
/api/hubs/{hub}/users/{user}/groups
DELETE
요약
모든 그룹에서 사용자를 제거합니다.
모든 그룹에서 사용자 제거
DELETE /api/hubs/{hub}/users/{user}/groups
매개 변수
속성
위치
설명
필수
스키마
hub
경로
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다.
예
string
user
경로
대상 사용자 ID
예
string
애플리케이션
query
대상 애플리케이션 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다.
아니요
string
api-version
query
REST API의 버전입니다.
예
string
응답
모델
ErrorDetail
오류 개체입니다.
속성
형식
설명
필수
코드
string
서버에서 정의한 오류 코드 집합 중 하나입니다.
아니요
message
string
사람이 읽을 수 있는 오류 표현입니다.
아니요
target
string
오류의 대상입니다.
아니요
details
[ ErrorDetail ]
이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
아니요
내부
InnerError 아니요
InnerError
속성
형식
설명
필수
코드
string
포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
아니요
내부
InnerError 아니요
PayloadMessage
속성
형식
설명
필수
target
string
예
arguments
[ ]
아니요
ServiceResponse
속성
형식
설명
필수
코드
string
예
level
string
열거형: "Info", "Warning""Error" 아니요
scope
string
Enum: "Unknown", "Request", "Connection", "User""Group" 아니요
errorKind
string
열거형: "Unknown", "NotExisted", "NotInGroup""Invalid" 아니요
message
string
아니요
jsonObject
아니요
isSuccess
부울 값
아니요