调用ListGroups获取人群列表_机器学习-阿里云帮助中心

获取人群列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paiplugin:ListGroups	Read	PAI acs:paiplugin::{#accountId}:*	无	无

请求参数

名称	类型	必填	描述	示例值
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	array	人群列表。
	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

错误码

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