调用CheckLiveMessageUsersOnline查询指定的用户是否在线。
接口说明
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:CheckLiveMessageUsersOnline | none | *Domain acs:live:*:{#accountId}:domain/{#DomainName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用 ID。 | demo |
UserIds | array | 是 | 需要查询的用户列表。 | |
string | 是 | 需要查询的用户 ID。多个用半角逗号(,)隔开。单次查询用户数量范围[1,10]。 | uid | |
DataCenter | string | 否 | 数据中心,需要与 CreateLiveMessageApp 中的数据中心一致,当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 | cn-shanghai |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "178F572F-AECF-100B-937A-B8047B4D****",
"UserList": [
{
"Online": false,
"UserId": "uid1"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InputInvalid | %s. | 输入参数不合法 |
403 | NoAuth | %s. | 没有权限 |
404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史