You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/数据档案/获取已导入的用户属性列表 - GetProperties
获取已导入的用户属性列表 - GetProperties
最近更新时间：2025.01.15 11:35:30首次发布时间：2024.07.12 14:50:50
我的收藏

请求说明

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

是

GetProperties

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

ApiVersion

String

是

2024-05-22

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

project_id

String

是

1

项目ID

keyword

String

否

xxx

关键字

online_status_code

Int

否

0

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

datasource_id

Int

否

37

数据源ID

subject_id

Int

否

1

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

Body

无

返回参数

参数

类型

示例值

描述

total

Int

10

总数

code

Int

0

状态码，0表示正常

msg

String

""

接口返回信息

properties

Array

[]

属性列表

PropertyDetail

参数

类型

示例值

描述

id

Int

307

id

name

String

city

名称

expr

String

city

表达式

dataType

String

string

数据类型

onlineStatus

String

0

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

latestAvailableDate

String

2024-05-10

最近一次可用日期

showName

String

city

显示名称

datasourceId

Int

37

数据源ID

datasourceName

String

utotest_user_cdp11131836_改名

数据源名称

请求示例

GET /?ApiAction=GetProperties&ApiVersion=2024-05-22&project_id=1&keyword=xxx&online_status_code=0&datasource_id=37&subject_id=1

返回示例

{
    "properties": [
        {
            "id": 307,
            "name": "city",
            "expr": "city",
            "dataType": "string",
            "onlineStatus": "COMPLETED",
            "showName": "city",
            "datasourceId": 34,
            "datasourceName": "autotest_user_cdp11131836_改名"
        },
        {
            "id": 324,
            "name": "department_1",
            "expr": "department_1",
            "dataType": "string",
            "onlineStatus": "COMPLETED",
            "showName": "department_1",
            "datasourceId": 34,
            "datasourceName": "autotest_user_cdp11131836_改名"
        }
    ],
    "total": 2,
    "code": 200
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。