Azure SignalR 服务数据平面 REST API - v1
本文包含用于 Azure SignalR 服务数据平面的 v1 版本 REST API。
可用 API
将消息广播到所有连接到目标中心的客户端。
POST /api/v1/hubs/{hub}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| 已排除 |
query |
已排除的连接 ID |
否 |
[ string ] |
响应
将消息广播到所有属于目标用户的客户端。
POST /api/v1/hubs/{hub}/users/{id}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| id |
path |
用户 ID。 |
是 |
string |
响应
将消息发送到特定连接。
POST /api/v1/hubs/{hub}/connections/{connectionId}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| connectionId |
path |
连接 ID。 |
是 |
string |
响应
检查是否存在与给定 connectionId 的连接
GET /api/v1/hubs/{hub}/connections/{connectionId}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
|
是 |
string |
| connectionId |
path |
|
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
关闭客户端连接
DELETE /api/v1/hubs/{hub}/connections/{connectionId}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
|
是 |
string |
| connectionId |
path |
|
是 |
string |
| reason |
query |
|
否 |
string |
响应
将消息广播到目标组中的所有客户端。
POST /api/v1/hubs/{hub}/groups/{group}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
string |
| 已排除 |
query |
已排除的连接 ID |
否 |
[ string ] |
响应
检查给定组中是否存在任何客户端连接
GET /api/v1/hubs/{hub}/groups/{group}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
|
是 |
string |
| group |
path |
|
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
检查是否存在任何为给定用户连接的客户端连接
GET /api/v1/hubs/{hub}/users/{user}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
|
是 |
字符串 |
| user |
path |
|
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
添加与目标组的连接。
PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
string |
| connectionId |
path |
目标连接 ID |
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
从目标组中删除连接。
DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
string |
| connectionId |
path |
目标连接 ID |
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
检查目标组中是否存在用户。
GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
字符串 |
| user |
path |
目标用户 ID |
是 |
string |
响应
| 代码 |
说明 |
| 200 |
Success |
| 400 |
错误的请求 |
| 404 |
未找到 |
将用户添加到目标组。
PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
字符串 |
| user |
path |
目标用户 ID |
是 |
string |
| ttl |
query |
指定用户在组中存在的秒数。 如果未设置该项，则用户在组中最多保留 1 年。 请注意，如果未设置 ttl，服务会为每个用户保留 100 个用户组关系，而旧的用户组关系将被新添加的用户组关系覆盖。 |
否 |
integer |
响应
从目标组中删除用户。
DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
string |
| group |
path |
目标组名称，其长度必须大于 0 且小于 1025。 |
是 |
字符串 |
| user |
path |
目标用户 ID |
是 |
string |
响应
从所有组中删除用户。
DELETE /api/v1/hubs/{hub}/users/{user}/groups
参数
| 名称 |
所在位置 |
描述 |
必需 |
架构 |
| 中心 |
path |
目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。 |
是 |
字符串 |
| user |
path |
目标用户 ID |
是 |
string |
响应
| 代码 |
说明 |
| 200 |
用户已删除 |
| 202 |
已接受删除请求，服务正在后台处理该请求 |
| 400 |
错误的请求 |
模型
PayloadMessage
| 名称 |
Type |
描述 |
必需 |
| 目标 |
string |
|
否 |
| 参数 |
[ object ] |
|
否 |