Azure SignalR Service 데이터 평면 REST API - v1
이 문서에는 Azure SignalR Service 데이터 평면에 대한 v1 버전 REST API가 포함되어 있습니다.
사용 가능한 API
메시지를 대상 허브에 연결된 모든 클라이언트에 브로드캐스트합니다.
POST /api/v1/hubs/{hub}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| 제외됨 |
쿼리 |
제외된 연결 ID |
아니요 |
[ string ] |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
메시지를 대상 사용자에게 속한 모든 클라이언트에 브로드캐스트합니다.
POST /api/v1/hubs/{hub}/users/{id}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| id |
경로 |
사용자 ID입니다. |
예 |
string |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
메시지를 특정 연결에 보냅니다.
POST /api/v1/hubs/{hub}/connections/{connectionId}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| connectionId |
경로 |
연결 ID입니다. |
예 |
string |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
지정된 connectionId와의 연결이 있는지 확인합니다.
GET /api/v1/hubs/{hub}/connections/{connectionId}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
|
예 |
string |
| connectionId |
경로 |
|
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
클라이언트 연결을 닫습니다.
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
|
예 |
string |
| connectionId |
경로 |
|
예 |
string |
| reason |
쿼리 |
|
아니요 |
string |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
대상 그룹 내의 모든 클라이언트에게 메시지를 브로드캐스트합니다.
POST /api/v1/hubs/{hub}/groups/{group}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| 제외됨 |
쿼리 |
제외된 연결 ID |
아니요 |
[ string ] |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
지정된 그룹 내에 클라이언트 연결이 있는지 확인합니다.
GET /api/v1/hubs/{hub}/groups/{group}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
|
예 |
string |
| group |
경로 |
|
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
지정된 사용자에 대해 연결된 클라이언트 연결이 있는지 확인합니다.
GET /api/v1/hubs/{hub}/users/{user}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
|
예 |
string |
| user |
경로 |
|
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
연결을 대상 그룹에 추가합니다.
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| connectionId |
경로 |
대상 연결 ID |
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
대상 그룹에서 연결을 제거합니다.
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| connectionId |
경로 |
대상 연결 ID |
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
사용자가 대상 그룹에 있는지 확인합니다.
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| user |
경로 |
대상 사용자 ID |
예 |
string |
응답
| 코드 |
설명 |
| 200 |
성공 |
| 400 |
Bad Request |
| 404 |
Not Found |
사용자를 대상 그룹에 추가합니다.
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| user |
경로 |
대상 사용자 ID |
예 |
string |
| ttl |
쿼리 |
사용자가 그룹에 존재하는 시간(초)을 지정합니다. 설정하지 않으면 사용자는 최대 1년 동안 그룹에 존재합니다. ttl이 설정되지 않은 경우 서비스는 사용자당 100개의 사용자 그룹 관계를 유지하며, 이전 사용자 그룹 관계는 새로 추가된 관계로 덮어씁니다. |
아니요 |
정수 |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
대상 그룹에서 사용자를 제거합니다.
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| group |
경로 |
길이가 0보다 크고 1025보다 작아야 하는 대상 그룹 이름입니다. |
예 |
string |
| user |
경로 |
대상 사용자 ID |
예 |
string |
응답
| 코드 |
설명 |
| 202 |
성공 |
| 400 |
Bad Request |
모든 그룹에서 사용자를 제거합니다.
DELETE /api/v1/hubs/{hub}/users/{user}/groups
매개 변수
| 속성 |
위치: |
설명 |
필수 |
스키마 |
| hub |
경로 |
대상 허브 이름 - 영문자로 시작하고 영숫자 문자 또는 밑줄만 포함해야 합니다. |
예 |
string |
| user |
경로 |
대상 사용자 ID |
예 |
string |
응답
| 코드 |
설명 |
| 200 |
사용자가 삭제됨 |
| 202 |
삭제 요청이 수락되고 서비스가 백그라운드에서 요청을 처리하고 있습니다. |
| 400 |
Bad Request |
모델
PayloadMessage
| 이름 |
종류 |
설명 |
필수 |
| 대상 |
string |
|
아니요 |
| 인수 |
[ 개체 ] |
|
아니요 |