You need to enable JavaScript to run this app.
导航
GetTags - 获取已经导入的标签列表
最近更新时间:2024.07.25 14:46:08首次发布时间:2024.07.10 15:50:06

请求说明

  • 请求方式: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

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

ApiVersion

String

GetTags

版本号: 2023-05-22

project_id

String

1

项目ID

keyword

String

关键字

online_status_code

Int

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

user_name

String

用户名称

subject_id

Int

主体id

page

Int

当前页

page_size

Int

页大小

Body


返回参数

参数

类型

示例值

描述

msg

String

成功

接口返回信息

code

Number

0

状态码,0表示正常

data

Object

{
    "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
}

接口返回

请求示例

返回示例

"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

参数非法,检查入参。