You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/标签体系/ 获取已经导入的标签列表 - GetTags
获取已经导入的标签列表 - GetTags
最近更新时间：2024.12.06 13:08:24首次发布时间：2024.07.12 14:50:45
我的收藏

请求说明

  • 请求方式：GET
  • 接口名称：GetTags
  • 请求地址：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

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

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

是

GetTags

固定值，对应“请求说明”中的“接口名称”

ApiVersion

String

是

2024-05-22

固定值，版本号： 2024-05-22

project_id

String

是

1

项目ID，详细介绍请查阅调用方式文档

keyword

String

否

关键字，可模糊搜索匹配

online_status_code

Int

否

在线状态，0-未开启，1-开启，但数据未就绪，2-开启且数据就绪过，注意：这里不代表已经是最新的数据，只是成功过

user_name

String

否

用户名称

subject_id

Int

是

主体ID，参考附录-主体ID获取方式

page

Int

否

当前页

page_size

Int

否

页大小

Body

无

返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码，0表示正常

page

Number

1

页码

total

Number

100

标签总数

tags

Array[TagDetail]

接口返回

TagDetail

参数

类型

描述

id

Number

id

name

String

名称

idType

Number

id 类型

actions

Array[
String]

认证状态 0-admin,1-Read_Role,2-Write_Role

tagType

String

标签类型

dataType

String

数据类型

createWay

String

创建路径

description

String

描述

onlineStatus

String

在线状态，0 - 未开启，1 - 开启，但数据未就绪，2 - 开启且数据就绪过，注意：这里不代表已经是最新的数据，只是成功过

latestAvailableDate

String

最近一次可用日期

请求示例

{
    "projectId": 1,
    "subjectId": 1
}

返回示例

"data":{
    "tags": [
        {
            "id": 104,
            "name": "规则标签多值",
            "idType": 1,
            "createWay": "rule",
            "dataType": "array_string",
            "description": "",
            "tagType": "",
            "onlineStatus": "COMPLETED",
            "actions": [
                "WRITE_ROLE",
                "READ_ROLE"
            ]
        },
        {
            "id": 1,
            "name": "主体_全量",
            "idType": 1,
            "createWay": "mautag",
            "dataType": "bigint",
            "description": "",
            "tagType": "",
            "onlineStatus": "COMPLETED",
            "actions": [
                "WRITE_ROLE",
                "READ_ROLE"
            ]
        }
    ],
    "page": 1,
    "total": "8",
    "code": 200
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。