搜索用户

接口概述

根据账号关键字搜索用户列表

接口URL

GET Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/user/queryUserList

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

请求参数

公共请求参数（HEADERS）

参数	类型	是否必选	描述
tenant-id	String	是	租户ID，用于指标查询内容所在的租户
auth-type	String	是	认证方式，用于设置身份认证方式 UID：使用 UID 进行身份认证TOKEN：使用 TOKEN 进行身份认证ACCOUNT：使用ACCOUNT 进行身份认证
auth-value	String	是	UID、TOKEN值、ACCOUNT，与auth-type 类型选择一致

请求参数

参数	类型	是否必选	最大长度	描述	示例值
keyword	String	是		根据请求内容进行用户模糊查询，为空时查询所有的用户	CAN

响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	String	是	32	接口响应码	200
succeess	boolean	是		是否成功	true
errorMsg	String	是	512	报错信息	NULL
detailErrorMsg	String	是	512	请求失败的报错详情	NULL
traceId	String	是	128	traceId	fdde343f9ff2dcd70.292.16857691758642861
data	String	是	32	返回userId	478209624953061376

请求示例

curl --location --request GET 'http://127.0.0.1:8083/anymetrics/api/v1/user/queryUserList?keyword=CAN' \
--header 'auth-type: UID' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'Accept-Language: zh-CN' \

响应示例

{
    "data": [
        {
            "userId": "567771175170605058",
            "nickname": "canc1",
            "account": "CAN_C1"
        }
    ],
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "c397f866392e4a9e885c8a6c4f39fdb5.182.17466744512500961"
}