You need to enable JavaScript to run this app.
导航
客户数据平台（私有化）
  • 文档首页
    • /客户数据平台（私有化）/开放能力/OpenAPI/标签体系/GetLabels - 根据项目id获取项目下的标签列表
GetLabels - 根据项目id获取项目下的标签列表
最近更新时间：2024.08.29 17:13:48首次发布时间：2024.07.10 15:50:06
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：GetLabels
  • 请求地址：https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

是

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

Int

是

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

GetLabels

对应“请求说明”中的“接口名称”

ApiVersion

String

是

2023-06-20

版本号： 2023-06-20

subjectId

Int

否

1

主体id

Body

无

返回参数

下表仅列出返回参数中data字段内容。

参数

类型

示例值

描述

id

Int

4

标签ID

name

String

autotest_quanliang03181231

标签名称

orgId

Int

1

集团ID

projectId

Int

1

项目ID

descr

String

""

描述

dataSecurityLevel

String

null

安全等级（暂废弃）

labelType

String

rule

创建方式：
rule（规则）
import（导入）
manual（人工）
logic （逻辑）
combine （组合）
ml_model（机器学习模型）
etl_model（数据清洗模型）
hive_sql（hive sql标签）
clickhouse_sql （ch sql标签）
multi_stage（多阶段）
rfm （rfm）
preference（偏好）

dataTypeName

String

string

标签值类型：
文本型：string
数值型：bigint
小数型：double
多值文本型：array_string
日期型：date
时间日期型：datetime
多值数值型：array_bigint
多值日期型：array_date
多值日期时间型：array_datetime

domainId

Int

-2

所属标签目录路径id

position

Number

3

当前子节点目录排序

entityId

Int

1

ID类型的编号

entityType

String

baseid

ID类型名称

computeType

String

offline

更新方式：
offline: 离线，realtime: 实时

isMautag

Int

0

是否为标识“全量用户”的标签（可不关注）

syncParams

Object

{
                "scheduleConf":{
                    "frequency":"d",
                    "scheduleTime":"02:00:00"
                },
                 "syncType":1
            }

调度信息（下含数组）

conf

Object

{
                "layers":[
                    {
                        "filter":{
                            "operator":"And",
                            "filters":[
                                {
                                    "operator":"And",
                                    "filters":[
                                        {
                                            "operator":"=",
                                            "tagId":3,
                                            "value":0
                                        }
                                    ]
                                }
                            ]
                        },
                        "name":"标签值1"
                    }
                ]
            }

标签规则（下含数组）

taskId

Int

100000018

任务ID

dimMetId

Int

282

-（可不关注）

labelRangeRules

String

null

人工标签规则

status

Int

0

标签状态：状态机：0-正常，1-删除

createApiTask

Bool

false

是否导入在线服务

realtimeTaskId

Int

null

实时任务ID（仅实时标签有该字段）

realtimeStatus

Int

null

实时任务最新状态（仅实时标签有该字段）

owner

String

admin

创建人

createTime

String

2023-03-18 12:42:47

创建时间

updater

String

admin

最新编辑人

updateTime

String

2023-03-18 12:42:50

最新编辑时间

abiDimMetId

Int

0

-（可以不关注）

lastSuccessTaskInstanceId

Int

1192

最后更新成功的任务ID

latestRunDate

String

2023-04-25

最后更新时间：返回格式 yyyy-MM-dd

userNum

Int

5124

覆盖用户数

values

Array[String]

null

枚举值

invokerCount

Int

引用次数(1.24新增)

queryCount

Int

查询次数(1.24新增)

请求示例

返回示例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "id":4,
            "name":"autotest_quanliang03181231",
            "orgId":1,
            "projectId":1,
            "descr":"",
            "dataSecurityLevel":null,
            "labelType":"rule",
            "dataTypeName":"string",
            "domainId":-2,
            "position":3,
            "entityId":1,
            "entityType":"baseid",
            "computeType":"offline",
            "isMautag":0,
            "syncParams":{
                "scheduleConf":{
                    "frequency":"d",
                    "scheduleTime":"02:00:00"
                },
                "syncType":1
            },
            "conf":{
                "layers":[
                    {
                        "filter":{
                            "operator":"And",
                            "filters":[
                                {
                                    "operator":"And",
                                    "filters":[
                                        {
                                            "operator":"=",
                                            "tagId":3,
                                            "value":0
                                        }
                                    ]
                                }
                            ]
                        },
                        "name":"标签值1"
                    }
                ]
            },
            "taskId":100000018,
            "dimMetId":282,
            "labelRangeRules":null,
            "status":0,
            "createApiTask":false,
            "realtimeTaskId":null,
            "realtimeStatus":null,
            "owner":"admin",
            "createTime":"2023-03-18 12:42:47",
            "updater":"admin",
            "updateTime":"2023-03-18 12:42:50",
            "abiDimMetId":0,
            "lastSuccessTaskInstanceId":1192,
            "latestRunDate":"2023-04-25",
            "userNum":5124,
            "values":null
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。