Azure SignalR Service 資料平面 REST API - v1
本文包含適用于 Azure SignalR Service 資料平面的 v1 版 REST API。
可用的 API
將訊息廣播至連線至目標中樞的所有用戶端。
POST /api/v1/hubs/{hub}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 排除 |
query |
排除的連接識別碼 |
No |
[ string ] |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
將訊息廣播給所有用戶端屬於目標使用者。
POST /api/v1/hubs/{hub}/users/{id}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| id |
path |
使用者識別碼。 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
將訊息傳送至特定連線。
POST /api/v1/hubs/{hub}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| connectionId |
path |
連接識別碼。 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
檢查具有指定 connectionId 的連線是否存在
GET /api/v1/hubs/{hub}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
|
Yes |
string |
| connectionId |
path |
|
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
關閉用戶端連線
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
|
Yes |
string |
| connectionId |
path |
|
Yes |
string |
| reason |
query |
|
No |
string |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
將訊息廣播至目標群組內的所有用戶端。
POST /api/v1/hubs/{hub}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| 排除 |
query |
排除的連接識別碼 |
No |
[ string ] |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
檢查指定群組內是否有任何用戶端連線
GET /api/v1/hubs/{hub}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
|
Yes |
string |
| 群組 |
path |
|
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
檢查指定使用者是否有任何用戶端連線
GET /api/v1/hubs/{hub}/users/{user}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
|
Yes |
string |
| 使用者 |
path |
|
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
將連線新增至目標群組。
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| connectionId |
path |
目標連線識別碼 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
從目標群組移除連線。
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| connectionId |
path |
目標連線識別碼 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
檢查使用者是否存在於目標群組中。
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| 使用者 |
path |
目標使用者識別碼 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
Success |
| 400 |
不正確的要求 |
| 404 |
找不到 |
將使用者新增至目標群組。
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| 使用者 |
path |
目標使用者識別碼 |
Yes |
string |
| ttl |
query |
指定使用者存在於群組中的秒數。 如果未設定，使用者最多會生活在群組中 1 年。 請注意，如果未設定 ttl，服務會保留每個使用者的 100 個使用者群組關聯性，而新加入的使用者群組關聯性會覆寫舊的使用者群組關聯性。 |
No |
整數 |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
從目標群組移除使用者。
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 群組 |
path |
目標群組名，其長度必須大於 0 且小於 1025。 |
Yes |
string |
| 使用者 |
path |
目標使用者識別碼 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 202 |
Success |
| 400 |
不正確的要求 |
從所有群組中移除使用者。
DELETE /api/v1/hubs/{hub}/users/{user}/groups
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 集線器 |
path |
目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。 |
Yes |
string |
| 使用者 |
path |
目標使用者識別碼 |
Yes |
string |
回覆
| 代碼 |
描述 |
| 200 |
使用者已刪除 |
| 202 |
已接受刪除要求，且服務正在處理背景中的要求 |
| 400 |
不正確的要求 |
模型
PayloadMessage
| 名稱 |
類型 |
描述 |
必要 |
| 目標 |
string |
|
No |
| 引數 |
[ 物件 ] |
|
No |