跳转至

删除用户

接口概述

本接口用于删除指定用户

接口URL

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

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 类型选择一致

请求参数

参数 类型 是否必选 最大长度 描述 示例值
userid String 32 被删除用户的 Userid account123

响应参数

参数 类型 是否必选 最大长度 描述 示例值
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/delete' \
--header 'auth-type: UID' \
--header 'tenant-id: tn_19487697' \
--header 'auth-value: 463663891121963008' \
--header 'Accept-Language: zh-CN' \
--data-raw '{
    "userId":"575645969954111488"
}'

响应示例

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