ListExperimentGroups - 获取实验组列表

获取实验组列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/experimentgroups HTTP/1.1

请求参数

名称类型必填描述示例值
LayerIdstring

层 ID,可通过接口 ListLayers 获取。

3
Statusstring

状态过滤 ● Offline-未上线 ● Online-已上线 ● Pushed-已推全

Online
InstanceIdstring

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-abcdefg1234
RegionIdstring

区域 ID。

cn-beijing
TimeRangeStartstring

根据开始时间进行实验组过滤。

2024-08-30 12:00:00
TimeRangeEndstring

根据结束时间进行实验组过滤。

2024-08-31 12:00:00

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

59CE7EC6-F268-5D71-9215-32922CC50D72
TotalCountlong

列表内元素总数。

10
ExperimentGroupsarray<object>

实验组列表。

ExperimentGroupsobject
ExperimentGroupIdstring

实验组 ID。

3
LayerIdstring

层 ID。

3
LaboratoryIdstring

实验室 ID。

4
SceneIdstring

场景 ID。

1
Namestring

实验组名称。

experiment_group1
Descriptionstring

实验组描述。

This is a test.
DebugUsersstring

调试用户。

1124512470******,1124512471******,1124512472******
DebugCrowdIdstring

调试人群 ID。

4
Ownerstring

创建人。

1124512470******
NeedAAboolean

是否需要 AB 实验组。

true
Filterstring

过滤条件。

gender=female
DistributionTypestring

分流方式。 ● UserId-用户 ID ● TimeDuration-时段

UserId
DistributionTimeDurationinteger

分流时段。

5
CrowdIdstring

人群 ID。

3
Configstring

实验组配置。

{}
ReservedBucketsstring

预留桶号。

1,2,3,4
Statusstring

实验组状态。 ● Offline-未上线 ● Online-已上线 ● Pushed-已推全

Offline
CrowdTargetTypestring

实验组流量定向的类型,可能的取值包括:

  • All 所有的流量
  • Filter 使用过滤条件的流量
  • CrowdId 通过指定人群 ID
  • Random 按照百分比随机流量
All
RandomFlowlong

当实验组流量定向的类型是 Random 时,使用随机流量匹配这个实验组,可能的取值范围是 0 - 100。

20
HoldingBucketsstring

当实验组流量定向的类型是 Random 时,根据随机流量 RandomFlow 大小,返回的具体的桶号。

1,2,3,4

示例

正常返回示例

JSON格式

{
  "RequestId": "59CE7EC6-F268-5D71-9215-32922CC50D72",
  "TotalCount": 10,
  "ExperimentGroups": [
    {
      "ExperimentGroupId": 3,
      "LayerId": 3,
      "LaboratoryId": 4,
      "SceneId": 1,
      "Name": "experiment_group1",
      "Description": "This is a test.",
      "DebugUsers": "1124512470******,1124512471******,1124512472******",
      "DebugCrowdId": 4,
      "Owner": "1124512470******",
      "NeedAA": true,
      "Filter": "gender=female",
      "DistributionType": "UserId",
      "DistributionTimeDuration": 5,
      "CrowdId": 3,
      "Config": {},
      "ReservedBuckets": "1,2,3,4",
      "Status": "Offline",
      "CrowdTargetType": "All",
      "RandomFlow": 20,
      "HoldingBuckets": "1,2,3,4"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-25OpenAPI 入参发生变更查看变更详情
2024-03-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情