You need to enable JavaScript to run this app.
导航
获取人群包详情 - LegacyGetSegment
最近更新时间:2024.12.06 13:07:29首次发布时间:2024.07.10 15:50:08

请求说明

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

LegacyGetSegment

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

ApiVersion

String

2023-02-10

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

tenantId

Int

1

项目ID

segId

Int

分群ID,参考:用户分群-分群ID字段

Body


返回参数

data字段内容

参数

类型

示例值

描述

id

Int

1729

分群包id

name

String

232333

分群名称

createBy

String

admin

创建者

idType

String

phoneid

ID类型code,参考:数据管理-ID图谱构建-OneID详情

idTypeName

String

手机号

ID类型

result

Json

{//分群最新结果,必有
      "count": 10016,//分群数量,非必有,任务未就绪,为null
      "path": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//分群离线文件地址,非必有,任务未就绪,为null
      "targetPath": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//同path
      "exportAt": "2021-05-13 10:45:23",//分群最新文件导出时间,必有,若问群任务未就绪,默认为创建时间
      "segStatus": "Normal"//分群状态,必有
    },

分群最新结果,结构说明参考下文

segType

String

Conditional

分群类型:Conditional(规则)*,*Uploaded(上传)等

abaseEnabled

Boolean

true

分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段

detail

Json

分群详情,仅当分群为规则分群时有值,结构参考下文

groupInfo

Array

分群分组详情,结构参考下文

encryptionMethod

String

分群加密方法(CDP1.23新增)

desc

String

分群描述(CDP1.24新增)

scheduleType

String

分群更新方式,默认一次性(CDP1.24新增)

dependencyResource

Array

分群依赖资源的类型列表(CDP1.24新增)

authRoleInfoList

Array

分群授权角色信息,仅在查询单个分群包生效(CDP1.24新增)

result 字段内容

参数

类型

示例值

描述

count

Int

10016

分群数量,非必有,任务未就绪,为null

path

String

/xxx/xxx.gz

分群离线文件地址,非必有,任务未就绪,为null,实时分群不包含今日实时数据

targetPath

String

/xxx/xxx.gz

同path

exportAt

String

2021-05-13 10:45:23

分群最新文件导出时间,必有,若分群任务未就绪,默认为创建时间

segStatus

String

normal

分群状态,必有 (Normal : 分群数据运行成功 ;Invalid: 分群运行失败 ;Exporting: 分群导入中。)

  • detail字段内容

参数

类型

示例值

描述

type

String

Conditional

分群类型:Conditional(规则)*,*Uploaded(上传)等

filter

Json

{
        "filters": [{
                "filters": [{
                        "tagId": 13,
                        "operator": "in",
                        "value": ["标签值"]
                }],
                "operator": "And"
        }],
        "operator": "And"
}

圈选条件dsl

  • groupInfol字段内容

参数

类型

示例值

描述

groupId

Int

2

groupId

groupName

String

测试分组

group名称

请求示例

{
    "tenantId": 1,
    "segId": 1
}

返回示例

{
  "data": {
    "id": 1729,//分群id,必有
    "name": "232333",//分群名称,必有
    "createdBy": "admin",//创建人,必有
    "idType": "phoneid",//目标实体code,必有
    "idTypeName": "手机号",//目标实体名称,必有
    "result": {//分群最新结果,必有
      "count": 10016,//分群数量,非必有,任务未就绪,为null
      "path": "/xxx/xxx.gz",//分群离线文件地址,非必有,任务未就绪,为null
      "targetPath": "/xxx/xxx.gz",//同path
      "exportAt": "2021-05-13 10:45:23",//分群最新文件导出时间,必有,若问群任务未就绪,默认为创建时间
      "segStatus": "Normal"//分群状态,必有
    },
    "segType": "Conditional",//分群类型,必有
    "abaseEnabled": true//分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段
  },
  "code": 0
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。