You need to enable JavaScript to run this app.
导航
PostLabels - 根据项目id获取项目下标签列表
最近更新时间:2024.09.04 17:08:08首次发布时间:2024.07.12 14:50:45

请求说明

  • 请求方式:POST
  • 接口名称:PostLabels
  • 请求地址: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

Long

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

PostLabels

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

ApiVersion

String

2023-07-03

版本号: 2023-07-03

subjectId

Int

1

主体id

type

String

标签类型

Body

参数

类型

是否必选

示例值

描述

projectId

Int

项目id

ids

Array[Int]

id列表

labelTypes

Array[String]

标签类型列表

subjectIds

Array[Int]

主体id列表

entityIds

Array[Int]

实体id列表

domainIds

Array[Int]

目录id列表

domainNames

String

目录名

nameLike

String

模糊搜索

statuses

Array[Int]

标签状态

taskIds

Array[Int]

任务id列表

computeTypes

Array[String]

计算类型

filterOrigin

Bool

是否过滤原来的表的标签

owners

Array[String]

owners

createTime

String

创建时间

frequencies

Array[String]

运行周期

syncTypes

Array[Int]

调度类型

latestRunDate

String

最近运行日期

userNum

Int

覆盖人数大于等于(仅作用于metaInfo)

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码,0表示正常

data

Object

[
        {
            "id":4,
            "name":"autotest_quanliang03181231",
            "orgId":1,
            "projectId":1,
            "descr":"",
            "dataSecurityLevel":null,
            "labelType":"rule",
            "dataTypeName":"string",
            "domainId":-2,
            "domainName": "",     // 生效版本 1.20
            "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
        }

接口返回

请求示例


返回示例

{
    "code":0,
    "msg":"成功",
    "data":[
        {
            "id":4,
            "name":"autotest_quanliang03181231",
            "orgId":1,
            "projectId":1,
            "descr":"",
            "dataSecurityLevel":null,
            "labelType":"rule",
            "dataTypeName":"string",
            "domainId":-2,
            "domainName": "",     // 生效版本 1.20
            "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

参数非法,检查入参。