跳转至

删除用户属性值

1. 接口说明

用于删除用户自定义属性的属性值。

版本支持

本文接口契约适用于 CAN 发布版本:V2.3.0+

2. 接口URL

POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/userPropertyValue/delete

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

3. 公共请求参数(HEADERS)

参数 类型 是否必选 描述
tenant-id String 租户 ID,用于标识资源所属租户
auth-type String 认证方式。支持 UIDTOKENACCOUNTAPIKEY
auth-value String auth-type 对应的认证值

3.1 公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成,在 API 集成界面获取;auth-value 请按 auth-type 填写对应认证值。

image.png

3.2. 请求体参数:

参数 类型 是否必选 描述
identityType String 用户标识类型(USER_ID 或 USER_ACCOUNT)
items Array 删除项列表
∟ identityValue String 用户标识值列表(用户ID列表或用户账号列表)
∟ propertyNames Array 要删除的属性名称列表

4. 请求示例:

curl --location 'http://localhost:8083/anymetrics/api/v1/userPropertyValue/delete' \
--header 'tenant-id: tn_21571046' \
--header 'auth-value: authority_test' \
--header 'auth-type: ACCOUNT' \
--header 'Content-Type: application/json' \
--data '{
  "identityType": "USER_ACCOUNT",
  "items": [
    {
      "identityValue": "zhangsan",
      "propertyNames": ["job_level", "region"]
    },
    {
      "identityValue": "lisi",
      "propertyNames": ["job_level"]
    }
  ]
}'

5. 返回示例:

{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "27cb89dae3b64e238acc50d5458e93e5.189.17761404544812179"
}