You need to enable JavaScript to run this app.
导航
查询不同的id类型之间的映射值 - GetIdMapping
最近更新时间:2024.12.06 13:07:31首次发布时间:2024.07.10 15:50:11

请求说明

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

GetIdMapping

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

ApiVersion

String

2023-02-10

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

Body

参数

类型

是否必选

示例值

描述

id

String

原始id类型的用户值

source_entity_name

String

需要转换的原始id类型的code, 例如 base_id, uid
source_entiy_name和target_entiry_name两个必须有一个是baseid

target_entity_name

String

目的id类型的code, 例如 base_id, uid
source_entiy_name和target_entiry_name两个必须有一个是baseid

interentity_strategy_id

Int

跨主体转换策略id (1.20.2 新增字段)
(选择哪个跨主体转换策略,去转化主体A-主体B的关系,不同的转换策略,主体A-主体B的映射关系就会不一样)

返回参数

参数

类型

示例值

描述

code

Int

msg

String

data

String

映射后的值(1->1),如果有多个只会返回1个

allData

Array

映射后的值(1->N) N<=10

请求示例

{
    "id": "576465150349934594",
    "source_entity_name": "baseid",
    "target_entity_name": "uid"
}

返回示例

{
    "code": 0,
    "msg": "success",
    "extra": "",
    "data": "2509",
    "allData": [
        "2509"
    ]
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。