调用ListGroups获取人群列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取人群列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/groups

请求参数

名称	类型	必填	描述	示例值
Name	string	否	人群名称过滤。	VIP客户
PageNumber	integer	否	分页数，从 1 开始，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10。	10
PhoneNumber	boolean	否	是否包含手机号过滤。	true
Remark	string	否	人群备注过滤。	充值大于一万
Source	integer	否	来源过滤。	0
Status	integer	否	审核状态过滤。	0

返回参数

名称	类型	描述	示例值
	object	成功获取人群列表。
Data	object	返回数据。
Groups	object []	人群列表。
Algorithm	string	关联算法，人群来源为算法。	user_recall
Amount	integer	人群数量。	0
Column	string	手机号列名，人群来源为 CSV 文件，MaxCompute，并且包含手机号时需指定。	phone
CreatedTime	string	创建时间 (UTC+8)。	2020-01-01 12:00:00
Filter	string	过滤条件，人群来源为 MaxCompute 时可指定。	ds=2022
Id	string	人群 ID。	0a54e195-03e2-40bd-869d-b71cb302783e
InferenceJobId	string	预测任务 ID，人群来源为算法。	0a54e195-03e2-40bd-869d-b71cb302783e
Name	string	人群名称。	VIP客户
PhoneNumber	boolean	是否包含手机号，包含手机号的人群可用于触达计划。	true
Project	string	MaxCompute(ODPS)项目名，人群来源为 MaxCompute 时需指定。	project
Remark	string	人群备注。	充值大于10万
Source	integer	人群来源。 0: 文本，每行一个手机号，最多 100 个。 1: 文本文件，每行一个手机号，可通过控制台上传或指定自定义 OSS 地址，指定自定义 OSS 地址前需确保已在控制台完成一键授权。 2: CSV 文件，需指定手机号列名，可通过控制台上传或指定自定义 OSS 地址，指定自定义 OSS 地址前需确保已在控制台完成一键授权。 3: MaxCompute(ODPS)表，需指定手机号列名。 4: 算法。	0
Status	integer	人群状态。 0: 检查中。 1: 已通过。 2: 未通过。	0
Table	string	MaxCompute(ODPS)表名，人群来源为 MaxCompute 时需指定。	recall
Text	string	文本，人群来源为文本时需指定。	1390000****
UpdatedTime	string	更新时间 (UTC+8)。	2020-01-01 12:00:00
Uri	string	文件地址，人群来源为文本文件，CSV 文件，MaxCompute 时需指定。	https://bucket.region.aliyuncs.com/folder/file
PageNumber	integer	分页数，从 1 开始，默认为 1。	1
PageSize	integer	分页大小，默认为 10。	10
TotalCount	integer	总人群数量。	10
ErrorCode	integer	错误码。	0
ErrorMessage	string	错误信息。	OK
RequestId	string	请求 ID。	f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "Groups": [
      {
        "Algorithm": "user_recall",
        "Amount": 0,
        "Column": "phone",
        "CreatedTime": "2020-01-01 12:00:00",
        "Filter": "ds=2022",
        "Id": "0a54e195-03e2-40bd-869d-b71cb302783e",
        "InferenceJobId": "0a54e195-03e2-40bd-869d-b71cb302783e",
        "Name": "VIP客户",
        "PhoneNumber": true,
        "Project": "project",
        "Remark": "充值大于10万",
        "Source": 0,
        "Status": 0,
        "Table": "recall",
        "Text": "1390000****",
        "UpdatedTime": "2020-01-01 12:00:00",
        "Uri": "https://bucket.region.aliyuncs.com/folder/file"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}

错误码

访问错误中心查看更多错误码。