You need to enable JavaScript to run this app.
导航
客户数据平台（私有化）
  • 文档首页
    • /客户数据平台（私有化）/开放能力/OpenAPI/在线服务/按租户获取在线可用的标签⧸属性⧸明细⧸行为列表 - GetOnlineTagsProp
按租户获取在线可用的标签⧸属性⧸明细⧸行为列表 - GetOnlineTagsProp
最近更新时间：2024.12.06 13:07:31首次发布时间：2024.07.10 15:50:11
我的收藏

请求说明

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

是

GetOnlineTagsProp

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

ApiVersion

String

是

2023-06-20

固定值，版本号： 2023-06-20

tenantCode

String

是

1

项目ID

infoType

String

是

选择需要查询标签（label）还是属性（property),行为（behavior）明细（detail），取值是：label，property，behavior，detail

current

Int

否

当前页

pageSize

Int

否

分页大小

idType

Int

否

标签的idtype ,传每个主体下面的base id 的id。

Body

{
   "tenantCode":"1",
   "infoType":"label",
   "current":1,
   "pageSize":10
}

返回参数

data字段内容

参数

类型

示例值

描述

items

Array

{
        "items": [
            {
                "id": 2,
                "name": "autotest0131/autotest_guize01311730",
                "status": "succeed",
                "LatestSuccessDate": "2023-02-12" ,//最新可用的日期
                "dataSourceId":1
            }
        ],
        "page": 1,
        "pageSize": 20,
        "total": 1
    }

返回的标签/属性/行为事件/明细信息

page

Int

1

pageSize

Int

20

total

Int

1

items 数组元素字段内容

参数

类型

示例值

描述

id

Int

2

对应标签/属性/行为/明细资源的id

name

String

autotest0131/autotest_guize0131173

对应资源的名称

status

String

succeed

在线资源状态，此接口只会返回succeed的资源

LatestSuccessDate

String

2023-02-12

最新可用的日期

dataSourceId

Int

1

资源对应的数据源id

请求示例

无

返回示例

{
    "data": {
        "items": [
            {
                "id": 2,
                "name": "autotest0131/autotest_guize01311730",
                "status": "succeed",
                "LatestSuccessDate": "2023-02-12", // 最新可用的日期
                "dataSourceId": 1
            }
        ],
        "page": 1,
        "pageSize": 10,
        "total": 1
    },
    "code": 0
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。