Azure SignalR 服务 REST API

版本:2022-06-01

可用 API

API 路径
获取服务运行状况。 HEAD /api/health
关闭中心中的所有连接。 POST /api/hubs/{hub}/:closeConnections
将消息广播到所有连接到目标中心的客户端。 POST /api/hubs/{hub}/:send
检查是否存在与给定 connectionId 的连接 HEAD /api/hubs/{hub}/connections/{connectionId}
关闭客户端连接 DELETE /api/hubs/{hub}/connections/{connectionId}
将消息发送到特定连接。 POST /api/hubs/{hub}/connections/{connectionId}/:send
检查给定组中是否存在任何客户端连接 HEAD /api/hubs/{hub}/groups/{group}
关闭特定组中的连接。 POST /api/hubs/{hub}/groups/{group}/:closeConnections
将消息广播到目标组中的所有客户端。 POST /api/hubs/{hub}/groups/{group}/:send
添加与目标组的连接。 PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
从目标组中删除连接。 DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
从所有组中删除某个连接 DELETE /api/hubs/{hub}/connections/{connectionId}/groups
检查是否存在任何为给定用户连接的客户端连接 HEAD /api/hubs/{hub}/users/{user}
关闭特定用户的连接。 POST /api/hubs/{hub}/users/{user}/:closeConnections
将消息广播到所有属于目标用户的客户端。 POST /api/hubs/{hub}/users/{user}/:send
检查目标组中是否存在用户。 HEAD /api/hubs/{hub}/users/{user}/groups/{group}
将用户添加到目标组。 PUT /api/hubs/{hub}/users/{user}/groups/{group}
从目标组中删除用户。 DELETE /api/hubs/{hub}/users/{user}/groups/{group}
从所有组中删除用户。 DELETE /api/hubs/{hub}/users/{user}/groups

/api/health

总结

获取服务运行状况。

获取服务运行状况

HEAD /api/health

参数
名称 所在位置 描述 必需 架构
api-version query REST API 的版本。 string
响应
代码 说明
200 服务正常
default 错误响应

/api/hubs/{hub}/:closeConnections

POST

总结

关闭中心中的所有连接。

关闭中心中的所有连接

POST /api/hubs/{hub}/:closeConnections

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
已排除 query 在关闭中心中的连接时排除这些 connectionId。 [ string ]
reason query 关闭客户端连接的原因。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
204 成功
default 错误响应 ErrorDetail

/api/hubs/{hub}/:send

POST

总结

将消息广播到所有连接到目标中心的客户端。

将消息广播到所有连接到目标中心的客户端

POST /api/hubs/{hub}/:send

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
已排除 query 已排除的连接 ID [ string ]
api-version query REST API 的版本。 string
message body 有效负载消息。 PayloadMessage
响应
代码 说明 架构
202 成功 ServiceResponse
default 错误响应 ErrorDetail

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

HEAD

总结

检查是否存在与给定 connectionId 的连接

检查是否存在与给定 connectionId 的连接

HEAD /api/hubs/{hub}/connections/{connectionId}

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
connectionId path 连接 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
default 错误响应 ErrorDetail

DELETE

总结

关闭客户端连接

关闭客户端连接

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
connectionId path 连接 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
reason query 连接关闭的原因。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
default 错误响应 ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/:send

POST

总结

将消息发送到特定连接。

将消息发送到特定连接

POST /api/hubs/{hub}/connections/{connectionId}/:send

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
connectionId path 连接 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
message body 有效负载消息。 PayloadMessage
响应
代码 说明 架构
202 成功 ServiceResponse
default 错误响应 ErrorDetail

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

HEAD

总结

检查给定组中是否存在任何客户端连接

检查给定组中是否存在任何客户端连接

HEAD /api/hubs/{hub}/groups/{group}

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
404 未找到
default 错误响应 ErrorDetail

/api/hubs/{hub}/groups/{group}/:closeConnections

POST

总结

关闭特定组中的连接。

关闭特定组中的连接

POST /api/hubs/{hub}/groups/{group}/:closeConnections

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
已排除 query 在关闭中心中的连接时排除这些 connectionId。 [ string ]
reason query 关闭客户端连接的原因。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
204 成功
default 错误响应 ErrorDetail

/api/hubs/{hub}/groups/{group}/:send

POST

总结

将消息广播到目标组中的所有客户端。

将消息广播到目标组中的所有客户端

POST /api/hubs/{hub}/groups/{group}/:send

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
已排除 query 已排除的连接 ID [ string ]
api-version query REST API 的版本。 string
message body 有效负载消息。 PayloadMessage
响应
代码 说明 架构
202 成功 ServiceResponse
default 错误响应 ErrorDetail

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

PUT

总结

添加与目标组的连接。

添加与目标组的连接

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 string
connectionId path 目标连接 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
404 未找到
default 错误响应 ErrorDetail

DELETE

总结

从目标组中删除连接。

从目标组中删除连接

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 string
connectionId path 目标连接 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
404 未找到
default 错误响应 ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/groups

DELETE

总结

从所有组中删除某个连接

从所有组中删除某个连接

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
connectionId path 目标连接 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
default 错误响应 ErrorDetail

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

HEAD

总结

检查是否存在任何为给定用户连接的客户端连接

检查是否存在任何为给定用户连接的客户端连接

HEAD /api/hubs/{hub}/users/{user}

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 字符串
user path 用户 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
404 未找到
default 错误响应 ErrorDetail

/api/hubs/{hub}/users/{user}/:closeConnections

POST

总结

关闭特定用户的连接。

关闭特定用户的连接

POST /api/hubs/{hub}/users/{user}/:closeConnections

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 字符串
user path 用户 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
已排除 query 在关闭中心中的连接时排除这些 connectionId。 [ string ]
reason query 关闭客户端连接的原因。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
204 成功
default 错误响应 ErrorDetail

/api/hubs/{hub}/users/{user}/:send

POST

总结

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

将消息广播到所有属于目标用户的客户端

POST /api/hubs/{hub}/users/{user}/:send

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 字符串
user path 用户 ID。 string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
message body 有效负载消息。 PayloadMessage
响应
代码 说明 架构
202 成功 ServiceResponse
default 错误响应 ErrorDetail

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

HEAD

总结

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

检查目标组中是否存在用户

HEAD /api/hubs/{hub}/users/{user}/groups/{group}

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 字符串
user path 目标用户 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
404 未找到
default 错误响应 ErrorDetail

PUT

总结

将用户添加到目标组。

将用户添加到目标组

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 字符串
user path 目标用户 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
ttl query 指定用户在组中存在的秒数。 如果未设置该项,则用户在组中最多保留 1 年。 如果将某个用户添加到某些没有 ttl 限制的组,则在该用户加入的所有没有 TTL 的组中,仅保留最新更新的 100 个组。 如果 ttl = 0,则只会将目标用户的当前已建立连接添加到目标组。 integer
api-version query REST API 的版本。 string
响应
代码 说明 架构
200 成功 ServiceResponse
default 错误响应 ErrorDetail

DELETE

总结

从目标组中删除用户。

从目标组中删除用户

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
group path 目标组名称,长度应大于 0 且小于 1025。 字符串
user path 目标用户 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
204 成功
default 错误响应 ErrorDetail

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

DELETE

总结

从所有组中删除用户。

从所有组中删除用户

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

参数
名称 所在位置 描述 必需 架构
中心 path 目标中心名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 字符串
user path 目标用户 ID string
application query 目标应用程序名称,应以字母字符开头,并且仅包含字母数字字符或下划线。 string
api-version query REST API 的版本。 string
响应
代码 说明 架构
204 成功
default 错误响应 ErrorDetail

模型

ErrorDetail

错误对象。

名称 Type 描述 必需
code string 服务器定义的一组错误代码中的一个。
message 字符串 错误的用户可读表示形式。
目标 string 错误的目标。
详细信息 [ ErrorDetail ] 有关导致此项报告错误的特定错误的详细信息数组。
内部 InnerError

InnerError

名称 Type 描述 必需
code string 比包含的错误提供的错误代码更具体的代码。
内部 InnerError

PayloadMessage

名称 Type 描述 必需
目标 string
参数 [ ]

ServiceResponse

名称 Type 描述 必需
code string
level string 枚举:"Info""Warning""Error"
scope string 枚举:"Unknown""Request""Connection""User""Group"
errorKind string 枚举:"Unknown""NotExisted""NotInGroup""Invalid"
message string
jsonObject
isSuccess boolean