Azure SignalR 服务数据平面 REST API - 2022-06-01

版本：2022-06-01

可用 API

API 路径
获取服务运行状况。 HEAD /api/health
关闭中心中的所有连接。 POST /api/hubs/{hub}/:closeConnections
将消息广播到所有连接到目标中心的客户端。 POST /api/hubs/{hub}/:send
检查带有该连接ID的连接是否存在 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 查询 REST API 的版本。 是 字符串
响应
Code 描述
200 服务正常
默认 错误响应

/api/hubs/{hub}/:closeConnections

POST

总结

关闭中心中的所有连接。

关闭中心中的所有连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
已排除 查询 关闭集线器连接时，排除这些连接ID。 否 [弦声]
reason 查询 关闭客户端连接的原因。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
204 成功
默认 错误响应 ErrorDetail

/api/hubs/{hub}/:send

POST

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
已排除 查询 排除的连接ID 否 [弦声]
api-version 查询 REST API 的版本。 是 字符串
消息 body 有效负载消息。 是 PayloadMessage
响应
Code 描述 架构
202 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

HEAD

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
connectionId 路径 连接 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
默认 错误响应 ErrorDetail

DELETE

总结

关闭客户端连接

关闭客户端连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
connectionId 路径 连接 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
reason 查询 连接关闭的原因。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

POST

总结

将消息发送到特定连接。

将消息发送到特定连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
connectionId 路径 连接 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
消息 body 有效负载消息。 是 PayloadMessage
响应
Code 描述 架构
202 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

HEAD

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
404 未找到
默认 错误响应 ErrorDetail

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

POST

总结

关闭特定组中的连接。

关闭特定组中的连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
已排除 查询 关闭集线器连接时，排除这些连接ID。 否 [弦声]
reason 查询 关闭客户端连接的原因。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
204 成功
默认 错误响应 ErrorDetail

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

POST

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
已排除 查询 排除的连接ID 否 [弦声]
api-version 查询 REST API 的版本。 是 字符串
消息 body 有效负载消息。 是 PayloadMessage
响应
Code 描述 架构
202 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

PUT

总结

添加与目标组的连接。

添加与目标组的连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
connectionId 路径 目标连接ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
404 未找到
默认 错误响应 ErrorDetail

DELETE

总结

从目标组中删除连接。

从目标组中删除连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
connectionId 路径 目标连接ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
404 未找到
默认 错误响应 ErrorDetail

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

DELETE

总结

从所有组中删除某个连接

从所有组中删除某个连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
connectionId 路径 目标连接ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

HEAD

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
用户 路径 用户 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
404 未找到
默认 错误响应 ErrorDetail

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

POST

总结

关闭特定用户的连接。

关闭特定用户的连接

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
用户 路径 用户 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
已排除 查询 关闭集线器连接时，排除这些连接ID。 否 [弦声]
reason 查询 关闭客户端连接的原因。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
204 成功
默认 错误响应 ErrorDetail

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

POST

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
用户 路径 用户 ID。 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
消息 body 有效负载消息。 是 PayloadMessage
响应
Code 描述 架构
202 成功 ServiceResponse
默认 错误响应 ErrorDetail

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

HEAD

总结

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

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

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
用户 路径 目标用户ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
200 成功 ServiceResponse
404 未找到
默认 错误响应 ErrorDetail

PUT

总结

将用户添加到目标组。

将用户添加到目标组

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

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

DELETE

总结

从目标组中删除用户。

从目标组中删除用户

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
组 路径 目标组名称，长度应大于 0 且小于 1025。 是 字符串
用户 路径 目标用户ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
204 成功
默认 错误响应 ErrorDetail

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

DELETE

总结

从所有组中删除用户。

从所有组中删除用户

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

参数
名称 所在位置 描述 必需 架构
中心 路径 目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 是 字符串
用户 路径 目标用户ID 是 字符串
应用程序 查询 目标应用程序名称，应以字母字符开头，并且仅包含字母数字字符或下划线。 否 字符串
api-version 查询 REST API 的版本。 是 字符串
响应
Code 描述 架构
204 成功
默认 错误响应 ErrorDetail

模型

ErrorDetail

错误对象。

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

InnerError

名称 类型 描述 必需
代码 字符串 比包含的错误提供的错误代码更具体的代码。 否
内 InnerError 否

PayloadMessage

名称 类型 描述 必需
目标 字符串 是
参数 【】 否

ServiceResponse

名称 类型 描述 必需
代码 字符串 否
水平仪 字符串 枚举："Info"、"Warning"、"Error" 否
作用域 字符串 枚举："Unknown"、"Request"、"Connection"、"User"、"Group" 否
errorKind 字符串 枚举："Unknown"、"NotExisted"、"NotInGroup"、"Invalid" 否
消息 字符串 否
jsonObject 否
isSuccess boolean 否
  • Last updated on