You need to enable JavaScript to run this app.
导航
getSegment - 查看人群包详情V2
最近更新时间:2024.10.14 11:52:01首次发布时间:2024.07.11 17:45:47

请求说明

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

getSegment

对应“请求说明”中的“接口名称”

ApiVersion

String

2024-05-22

版本号:2024-05-22

segId

Int

分群ID

Body


返回参数

data字段内容

参数

类型

示例值

描述

id

Int

1

分群id

name

String

分群名称

desc

String

“”

分群描述

condition

Object

分群规则

taskConf

Object

分群任务配置

taskResults

Array

分群最新任务状态

lastSuccessTaskResults

Array

分群最新成功任务状态

count

Int

人群数量

exportAt

String

分群导出时间

createdBy

String

创建人

createTime

String

创建时间

updatedBy

String

编辑人

updateTime

String

编辑时间

idType

id类型信息

sourcePlatform

String

来源平台

sourceModule

String

来源模块

deletedFlag

Int

软删除标记,0存在,1删除

segType

String

分群类型

tenantId

Int

租户id

bdbTaskId

Int

bdb任务id

childSegments

Array

子包信息

readable

Bool

是否可读

isHidden

Bool

是否隐藏(GMP人群可能会隐藏)

publicSegId

Int

私转公对应的其他人群包id

groupInfo

Array

组信息

onlineServiceTaskId

Int

在线导入任务id

请求示例

返回示例

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。