Azure SignalR 服务数据平面 REST API - v1

本文包含Azure SignalR 服务数据平面的v1版本REST API。

可用 API

API 路径
向所有连接到目标枢纽的客户端广播消息。 POST /api/v1/hubs/{hub}
向所有属于目标用户的客户端广播消息。 POST /api/v1/hubs/{hub}/users/{id}
向具体的连接发送消息。 POST /api/v1/hubs/{hub}/connections/{connectionId}
检查带有该连接ID的连接是否存在 GET /api/v1/hubs/{hub}/connections/{connectionId}
关闭客户端连接 DELETE /api/v1/hubs/{hub}/connections/{connectionId}
向目标组内的所有客户端广播消息。 POST /api/v1/hubs/{hub}/groups/{group}
检查该组内是否有客户端连接 GET /api/v1/hubs/{hub}/groups/{group}
检查该用户是否有连接的客户端连接 GET /api/v1/hubs/{hub}/users/{user}
为目标群体添加连接。 PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
从目标群体中移除连接。 DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
检查目标群体中是否存在用户。 GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
添加一个用户到目标群体。 PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
将目标群体中的一名用户移除。 DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
从所有组中移除一名用户。 DELETE /api/v1/hubs/{hub}/users/{user}/groups

向所有连接到目标枢纽的客户端广播消息。

POST /api/v1/hubs/{hub}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
排除 查询 排除的连接ID No [弦声]
Responses
Code Description
202 成功
400 错误的请求

向所有属于目标用户的客户端广播消息。

POST /api/v1/hubs/{hub}/users/{id}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
id 路径 用户 ID。 Yes 字符串
Responses
Code Description
202 成功
400 错误的请求

向具体的连接发送消息。

POST /api/v1/hubs/{hub}/connections/{connectionId}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
connectionId 路径 连接 ID。 Yes 字符串
Responses
Code Description
202 成功
400 错误的请求

检查带有该连接ID的连接是否存在

GET /api/v1/hubs/{hub}/connections/{connectionId}

参数
Name 位于 Description 必需 架构
中心 路径 Yes 字符串
connectionId 路径 Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

关闭客户端连接

DELETE /api/v1/hubs/{hub}/connections/{connectionId}

参数
Name 位于 Description 必需 架构
中心 路径 Yes 字符串
connectionId 路径 Yes 字符串
原因 查询 No 字符串
Responses
Code Description
202 成功
400 错误的请求

向目标组内的所有客户端广播消息。

POST /api/v1/hubs/{hub}/groups/{group}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
排除 查询 排除的连接ID No [弦声]
Responses
Code Description
202 成功
400 错误的请求

检查给定组内是否有任何客户端连接

GET /api/v1/hubs/{hub}/groups/{group}

参数
Name 位于 Description 必需 架构
中心 路径 Yes 字符串
组 路径 Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

检查该用户是否有连接的客户端连接

GET /api/v1/hubs/{hub}/users/{user}

参数
Name 位于 Description 必需 架构
中心 路径 Yes 字符串
用户 路径 Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

添加与目标组的连接。

PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
connectionId 路径 目标连接ID Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

从目标组中删除连接。

DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
connectionId 路径 目标连接ID Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

检查目标群体中是否存在用户。

GET /api/v1/hubs/{hub}/groups/{group}/users/{user}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
Responses
Code Description
200 成功
400 错误的请求
404 未找到

将用户添加到目标组。

PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
ttl 查询 指定用户在组中存在的秒数。 如果未设置，用户最多在该组中生活一年。 注意，当未设置 ttl 时，服务会保留每个用户 100 个用户组关系，旧用户组关系会被新添加的用户覆盖。 No 整数
Responses
Code Description
202 成功
400 错误的请求

从目标组中删除用户。

DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
组 路径 目标组名称，长度必须大于0且小于1025。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
Responses
Code Description
202 成功
400 错误的请求

从所有组中删除用户。

DELETE /api/v1/hubs/{hub}/users/{user}/groups

参数
Name 位于 Description 必需 架构
中心 路径 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 Yes 字符串
用户 路径 目标用户ID Yes 字符串
Responses
Code Description
200 该用户已被删除
202 删除请求被接受，服务在后台处理请求
400 错误的请求

模型

有效载荷消息

Name 类型 Description 必需
目标 字符串 No
Arguments [ 物体 ] No
  • Last updated on