You need to enable JavaScript to run this app.
导航
客户数据平台
  • 文档首页
    • /客户数据平台/开放能力/OpenAPI/IDMapping/按主体id获取实体列表 - GetSubjectIdTypes
按主体id获取实体列表 - GetSubjectIdTypes
最近更新时间：2024.12.06 13:08:26首次发布时间：2024.07.12 14:50:49
我的收藏

请求说明

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

是

GetSubjectIdTypes

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

ApiVersion

String

是

2023-02-10

固定值，版本号： 2023-02-10

subjectId

Int

是

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

Body

无

返回参数

data数组元素字段内容

参数

类型

示例值

描述

id

Integer

2

IdType的Id

subjectId

Integer

0

主体id

code

String

uid

IdType的code

name

String

uid

IdType的名称

dataType

String

string

IdType的数据类型

entityType

String

string

IdType的渠道标识

needEncrypt

String

string

废弃

finderIdType

String

string

Finder ID类型标识

请求示例

{
    "subjectId": 1
}

返回示例

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 2,
      "subjectId": 0,
      "code": "uid",
      "name": "uid",
      "dataType": "string",
      "entityType": "string",
      "needEncrypt": "string",
      "finderIdType": "string"
    }，
    {
      "id": 1,
      "subjectId": 0,
      "code": "baseid",
      "name": "baseid",
      "dataType": "string",
      "entityType": "string",
      "needEncrypt": "string",
      "finderIdType": "string"
    }
  ]
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法，检查入参。