全部产品
Search
文档中心

智能开放搜索 OpenSearch:CreateABTestExperiment - 创建 ABTest 测试实验

更新时间:Oct 16, 2024

创建实验。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:CreateApp
  • AbTestExperiment
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/scenes/{sceneId}/groups/{groupId}/experiments HTTP/1.1

请求参数

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

应用名称

my_app_group_name
sceneIdinteger

场景 ID

20404
groupIdinteger

组 ID

13467
dryRunboolean

是否校验入参数据合法性,默认 false。

取值:

  • true:只校验参数合法性。

  • false:校验参数合法性,创建归因配置。

false
bodyABTestExperiment

请求体

请求体

字段类型是否必要示例值描述
nameString"my_test"实验名称
trafficInteger30实验流量
onlineBooleantrue是否生效
paramsObject{"firstFormulaName": "default"}实验配置,参考:ABTestExperiment

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

实验详情

createdinteger

创建时间

0
paramsobject

实验参数

{"firstFormulaName": "default"}
trafficinteger

实验分桶百分比

30
onlineboolean

实验状态

  • true 生效
  • false 未生效
true
namestring

实验别名

test3
updatedinteger

最后修改时间

1589017861
idstring

实验 ID

12889

示例

正常返回示例

JSON格式

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 0,
    "params": {
      "firstFormulaName": "default"
    },
    "traffic": 30,
    "online": true,
    "name": "test3",
    "updated": 1589017861,
    "id": "12889"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-24OpenAPI 入参发生变更查看变更详情