跳转至

用户启用&停用

接口概述

本接口用于停用以及启用指定用户，支持单个用户和批量用户操作。

接口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、TOKEN、ACCOUNT、APIKEY
auth-value String 是 32 与 auth-type 对应的认证值

请求参数

参数 类型 是否必选 最大长度 描述 示例值
userId String 否 用户 ID。用于单个用户操作；userId 和 identities 至少传一个 463663891121963008
ban Boolean 是 用户状态。true 表示停用用户，false 表示启用用户 true
identities Object 否 批量用户标识。用于批量操作；userId 和 identities 至少传一个
identities.values Array 否 批量用户标识列表。当传 identities 时必填 ["463663891121963008"]
identities.identityType String 否 批量用户标识类型。支持 USER_ID、USER_ACCOUNT；为空时默认按 USER_ID 处理 USER_ID

响应参数

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

请求示例

单个用户启用

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
}'

批量停用用户

按用户 ID 批量停用：

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 '{
     "ban": true,
     "identities": {
          "identityType": "USER_ID",
          "values": [
               "463707832823316480",
               "463707832823316481"
          ]
     }
}'

按用户账号批量停用：

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 '{
     "ban": true,
     "identities": {
          "identityType": "USER_ACCOUNT",
          "values": [
               "zhangsan",
               "lisi"
          ]
     }
}'

响应示例

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