You need to enable JavaScript to run this app.
导航
按租户获取id类型列表 - ListIdTypeMetaByTenant
最近更新时间:2025.01.15 11:35:29首次发布时间:2024.07.12 14:50:49

请求说明

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

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

X-Tenant

String

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

ListIdTypeMetaByTenant

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

ApiVersion

String

2023-02-10

固定值,版本号: 2023-02-10

Body

返回参数

参数

类型

示例值

描述

code

Number

0

状态码,0表示正常

data

Array

[]

ID 类型数据

idTypeMeta

参数

类型

示例值

描述

subjectId

Int

1

主体id

subjectName

String

默认集团

主体名称

subjectType

String

Person

主体类型

idTypes

Array

[]

id 类型列表

idTypeDetail

参数

类型

示例值

描述

id

Int

1

ID类型唯一标识

code

String

baseid

ID类型code

name

String

基准ID

ID类型名称

dataType

String

Decimal

数据类型:String, Decimal, Composite

entityType

String

BaseId

实体类型:BaseId, Phone, Phone_SHA256, IDFA, IDFA_MD5, IMEI, IMEI_MD5, OAID, OAID_MD5, DeviceID, PrivateID, ByteId, DY_MpID_OpenID, DY_MpID_OpenID_MD5, WX_UnionID, WX_AppID_OpenID, DouDian_AppID_OpenID, WX_External_UserID, WX_Group_ChatID

needEncrypt

Bool

false

是否需要加密

subjectId

Int

1

主体id

subjectName

String

xxx

主体名称

orgId

Int

1

集团ID

subjectType

String

Person

主体类型

availableMappingIds

Array

[]

可用的idmapping策略

availableMappingIdsDetail

参数

类型

示例值

描述

targetEntityId

Int

2

目标id type标识

strategy

Array

[]

策略

strategyDetail

参数

类型

示例值

描述

strategyId

Int

1

策略id

strategyName

String

默认策略

策略名称

请求示例

GET /?ApiAction=ListIdTypeMetaByTenant&ApiVersion=2023-02-10

返回示例

{
    "code": 0,
    "data": [
        {
            "subjectId": 1,
            "subjectName": "主体1",
            "subjectType": "Person",
            "idTypes": [
                {
                    "id": 1,
                    "code": "baseid",
                    "name": "主体1的基准ID",
                    "dataType": "Decimal",
                    "entityType": "BaseId",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 6,
                    "code": "uid",
                    "name": "uid",
                    "dataType": "String",
                    "entityType": "IMEI_MD5",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 7,
                    "code": "device_id",
                    "name": "device_id",
                    "dataType": "String",
                    "entityType": "DeviceID",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 8,
                    "code": "web_id",
                    "name": "web_id",
                    "dataType": "String",
                    "entityType": "PrivateID",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                }
                {
                    "id": 24,
                    "code": "MD5_BASE64",
                    "name": "MD5_BASE64",
                    "dataType": "String",
                    "entityType": "Phone",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 26,
                    "code": "SHA256_BASE64",
                    "name": "SHA256_BASE64",
                    "dataType": "String",
                    "entityType": "Phone",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 28,
                    "code": "ECB128_BASE64",
                    "name": "ECB128_BASE64",
                    "dataType": "String",
                    "entityType": "Phone",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                },
                {
                    "id": 30,
                    "code": "CBC_128BASE64",
                    "name": "CBC_128BASE64",
                    "dataType": "String",
                    "entityType": "Phone",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                }
                {
                    "id": 36,
                    "code": "phone_sah256",
                    "name": "phone_sah256",
                    "dataType": "String",
                    "entityType": "Phone_SHA256",
                    "needEncrypt": false,
                    "subjectId": 1,
                    "subjectName": "1",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Person",
                    "referFinderId": false
                }
            ],
            "orgId": 1
        },
        {
            "subjectId": 2,
            "subjectName": "主体2",
            "subjectType": "Car",
            "idTypes": [
                {
                    "id": 13,
                    "code": "baseid_2",
                    "name": "基准",
                    "dataType": "Decimal",
                    "entityType": "BaseId",
                    "needEncrypt": false,
                    "subjectId": 2,
                    "subjectName": "2",
                    "availableMappingIds": [],
                    "orgId": 1,
                    "subjectType": "Car",
                    "referFinderId": false
                }
            ],
            "orgId": 1
        }
    ]
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。