Azure SignalR Service REST API
版本：2022-06-01
可用的 API
/api/health
HEAD
摘要
取得服務健康狀態。
取得服務健康狀態
HEAD /api/health
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
| 代碼 |
描述 |
| 200 |
服務狀況良好 |
| 預設值 |
回覆錯誤 |
/api/hubs/{hub}/：closeConnections
POST
摘要
關閉中樞中的所有連線。
關閉中樞中的所有連線
POST /api/hubs/{hub}/:closeConnections
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| 排除 |
query |
關閉中樞中的連線時，請排除這些 connectionId。 |
No |
[ string ] |
| reason |
query |
關閉客戶端連線的原因。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/：send
POST
摘要
將訊息廣播至連線至目標中樞的所有用戶端。
將訊息廣播至連線至目標中樞的所有用戶端
POST /api/hubs/{hub}/:send
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| 排除 |
query |
排除的連接標識碼 |
No |
[ string ] |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
| message |
本文 |
承載訊息。 |
Yes |
PayloadMessage |
回覆
/api/hubs/{hub}/connections/{connectionId}
HEAD
摘要
檢查具有指定 connectionId 的連線是否存在
檢查具有指定 connectionId 的連線是否存在
HEAD /api/hubs/{hub}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| connectionId |
path |
連接標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
DELETE
摘要
關閉用戶端連線
關閉用戶端連線
DELETE /api/hubs/{hub}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| connectionId |
path |
連接標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| reason |
query |
線上關閉的原因。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/connections/{connectionId}/：send
POST
摘要
將訊息傳送至特定連線。
將訊息傳送至特定連線
POST /api/hubs/{hub}/connections/{connectionId}/:send
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| connectionId |
path |
連接標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
| message |
本文 |
承載訊息。 |
Yes |
PayloadMessage |
回覆
/api/hubs/{hub}/groups/{group}
HEAD
摘要
檢查指定群組內是否有任何用戶端連線
檢查指定群組內是否有任何用戶端連線
HEAD /api/hubs/{hub}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/groups/{group}/：closeConnections
POST
摘要
關閉特定群組中的連線。
關閉特定群組中的連線
POST /api/hubs/{hub}/groups/{group}/:closeConnections
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| 排除 |
query |
關閉中樞中的連線時，請排除這些 connectionId。 |
No |
[ string ] |
| reason |
query |
關閉客戶端連線的原因。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/groups/{group}/：send
POST
摘要
將訊息廣播至目標群組內的所有用戶端。
將訊息廣播至目標群組內的所有用戶端
POST /api/hubs/{hub}/groups/{group}/:send
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| 排除 |
query |
排除的連接標識碼 |
No |
[ string ] |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
| message |
本文 |
承載訊息。 |
Yes |
PayloadMessage |
回覆
/api/hubs/{hub}/groups/{group}/connections/{connectionId}
PUT
摘要
將連線新增至目標群組。
將連線新增至目標群組
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| connectionId |
path |
目標線上標識碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
DELETE
摘要
從目標群組移除連線。
從目標群組移除連線
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| connectionId |
path |
目標線上標識碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/connections/{connectionId}/groups
DELETE
摘要
從所有群組移除連線
從所有群組移除連線
DELETE /api/hubs/{hub}/connections/{connectionId}/groups
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| connectionId |
path |
目標線上標識碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/users/{user}
HEAD
摘要
檢查指定使用者是否有任何客戶端連線
檢查指定使用者是否有任何客戶端連線
HEAD /api/hubs/{hub}/users/{user}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 使用者 |
path |
用戶標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/users/{user}/：closeConnections
POST
摘要
關閉特定用戶的連線。
關閉特定用戶的連線
POST /api/hubs/{hub}/users/{user}/:closeConnections
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 使用者 |
path |
用戶標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| 排除 |
query |
關閉中樞中的連線時，請排除這些 connectionId。 |
No |
[ string ] |
| reason |
query |
關閉客戶端連線的原因。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/users/{user}/：send
POST
摘要
將訊息廣播給所有用戶端屬於目標使用者。
將訊息廣播給所有用戶端屬於目標使用者
POST /api/hubs/{hub}/users/{user}/:send
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 使用者 |
path |
用戶標識碼。 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
| message |
本文 |
承載訊息。 |
Yes |
PayloadMessage |
回覆
/api/hubs/{hub}/users/{user}/groups/{group}
HEAD
摘要
檢查使用者是否存在於目標群組中。
檢查使用者是否存在於目標群組中
HEAD /api/hubs/{hub}/users/{user}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 使用者 |
path |
目標用戶識別碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
PUT
摘要
將使用者新增至目標群組。
將使用者新增至目標群組
PUT /api/hubs/{hub}/users/{user}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 使用者 |
path |
目標用戶識別碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| ttl |
query |
指定使用者存在於群組中的秒數。 如果未設定，使用者最多會住在群組中 1 年。 如果使用者新增至某些群組，但不受 ttl 限制，則只有最新更新的 100 個群組會保留於未使用 TTL 的使用者加入的所有群組中。 如果 ttl = 0，則只會將目標使用者目前的連線連線新增至目標群組。 |
No |
整數 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
DELETE
摘要
從目標群組移除使用者。
從目標群組移除使用者
DELETE /api/hubs/{hub}/users/{user}/groups/{group}
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 群組 |
path |
目標組名，其長度應大於0且小於1025。 |
Yes |
字串 |
| 使用者 |
path |
目標用戶識別碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
/api/hubs/{hub}/users/{user}/groups
DELETE
摘要
從所有群組中移除使用者。
從所有群組中移除使用者
DELETE /api/hubs/{hub}/users/{user}/groups
參數
| 名稱 |
位於 |
描述 |
必要 |
結構描述 |
| 中樞 |
path |
目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
Yes |
字串 |
| 使用者 |
path |
目標用戶識別碼 |
Yes |
字串 |
| 應用程式 |
query |
目標應用程式名稱，其開頭應為字母字元，且只包含英數位元或底線。 |
No |
字串 |
| api-version |
query |
REST API 的版本。 |
Yes |
字串 |
回覆
模型
ErrorDetail
error 物件。
| 名稱 |
類型 |
描述 |
必要 |
| code |
字串 |
其中一組伺服器定義的錯誤碼。 |
No |
| message |
字串 |
錯誤的人類可讀取表示法。 |
No |
| 目標 |
字串 |
錯誤的目標。 |
No |
| 詳細資料 |
[ ErrorDetail ] |
導致此錯誤之特定錯誤的詳細數據陣列。 |
No |
| inner |
InnerError |
|
No |
InnerError
| 名稱 |
類型 |
描述 |
必要 |
| code |
字串 |
比包含的錯誤所提供更明確的錯誤碼。 |
No |
| inner |
InnerError |
|
No |
PayloadMessage
| 名稱 |
類型 |
描述 |
必要 |
| 目標 |
字串 |
|
Yes |
| 參數 |
[ ] |
|
No |
ServiceResponse
| 名稱 |
類型 |
描述 |
必要 |
| code |
string |
|
No |
| level |
字串 |
列舉："Info"、、"Warning"、"Error" |
No |
| 範圍 (scope) |
字串 |
列舉："Unknown"、、、"Request""Connection"、"User"、"Group" |
No |
| errorKind |
字串 |
列舉："Unknown"、、"NotExisted"、"NotInGroup"、"Invalid" |
No |
| message |
字串 |
|
No |
| jsonObject |
|
|
No |
| isSuccess |
boolean |
|
No |