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

获取人群列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
pairec:ListCrowds	list	全部资源 ``	无	无

请求语法

GET /api/v1/crowds HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID，可通过接口 ListInstances 获取。	pairec-cn-abcdefg1234

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	9763624B-5FBB-5E3A-9193-B1ADB554CEAE
TotalCount	long	列表内元素总数。	10
Crowds	array<object>	人群列表。
Crowds	object
CrowdId	string	人群 ID。	3
Name	string	人群名称。	crowd1
Description	string	人群描述。	This is a test.
Label	string	人群标签。	os=android
Source	string	人群来源。 ManualInput：手工输入 UploadFile：文件上传	ManualInput
Quantity	string	数量。	10
Users	string	人群内包含的用户，多个用户间以逗号隔开。	user1,user2
GmtCreateTime	string	人群创建时间。	2021-12-15T23:24:33.132+08:00

示例

正常返回示例

JSON格式

{
  "RequestId": "9763624B-5FBB-5E3A-9193-B1ADB554CEAE",
  "TotalCount": 10,
  "Crowds": [
    {
      "CrowdId": 3,
      "Name": "crowd1",
      "Description": "This is a test.",
      "Label": "os=android",
      "Source": "ManualInput",
      "Quantity": 10,
      "Users": "user1,user2",
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00"
    }
  ]
}

错误码

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