参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | String | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | getSegmentListV2 | 对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-05-22 | 版本号：2024-05-22 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
pageSize | Int | 否 | 10 | 每页大小 |
pageNum | Int | 否 | 1 | 页码 |
idTypeId | Int | 否 | ID类型id | |
idTypeCode | String | 否 | 实体类型code | |
subjectId | Int | 否 | 主体ID | |
groupIds | String | 否 | 分组ID列表，逗号分隔 | |
keyword | String | 否 | 关键词，模糊搜索分群名称和创建人 | |
isSelfSee | Bool | 否 | 是否只看自己创建的 | |
showHidden | Bool | 否 | 是否展示隐藏分群 | |
domainType | String | 否 | 类型，值为Public或Private | |
majorIdValues | String | 否 | 主id筛选项 | |
onlineServiceEnabled | Bool | 否 | 是否开启在线服务 | |
orderBy | String | 否 | 排序键 | |
order | String | 否 | 排序方式，值为desc或asc | |
segmentTypes | Array | 否 | 分群类型列表，值为Conditional等 | |
scheduleTypes | Array | 否 | 调度类型列表，值为Once、Daily等 | |
fileStatus | Array | 否 | 文件任务状态列表，值为Created等 | |
bitmapStatus | Array | 否 | bitmap任务状态列表，值为Created等 | |
onlineServiceStatus | Array | 否 | 在线服务状态列表，值为Created等 | |
segIdLike | Int | 否 | 单个分群id过滤，仅在分群列表页生效 | |
subjectIds | Array | 否 | 多个主体id过滤，仅在分群列表页生效 | |
sourcePlatforms | Array | 否 | 来源平台列表 | |
encryptionMethods | Array | 否 | 加密方法列表，值为SHA256、MD5等 | |
viewer | String | 否 | 查看人，需要admin身份调用才能生效 | |
segIds | Array | 否 | 分群ID列表 | |
name | String | 否 | 名称 | |
createdBy | String | 否 | 创建者 |
data字段内容
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
total | Int | 10 | 总数 |
pageSize | Array | 10 | 每页大小 |
page | Array | 1 | 页码 |
data | Array | 结果 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
id | Int | 1 | 分群id |
name | String | 分群名称 | |
desc | String | "" | 分群描述 |
condition | 分群规则 | ||
taskConf | 分群任务配置 | ||
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 | 参数非法，检查入参。 |