用户启用&停用

接口概述

本接口用于停用以及启用指定用户

接口URL

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/user/updateUserBanStatus

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

请求参数

公共请求参数（HEADERS）

参数	类型	是否必选	最大长度	描述
tenant-id	String	是	32	租户ID，用于指标查询内容所在的租户
auth-type	String	是	32	认证方式支持：UID（基于用户ID认证）TOKEN（基于令牌认证）。
auth-value	String	是	32	与选定的auth-type相对应的认证值。

请求参数

参数	类型	是否必选	最大长度	描述	示例值
userId	String	是		用户 ID	463663891121963008
ban	Boolean	是		停用以及启用用户	true

响应参数

参数	类型	是否必选	最大长度	描述	示例值
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 POST 'https://127.0.0.1:8083/anymetrics/api/v1/user/updateUserBanStatus' \
--header 'auth-type: UID' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'Accept-Language: zh-CN' \
--data-raw '{
     "userId":"463707832823316480",
     "ban":false
}'

响应示例

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "c397f866392e4a9e885c8a6c4f39fdb5.181.17466755543990979"
}