ListLaboratories - 获取实验室列表

获取某个场景下的实验室列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/laboratories HTTP/1.1

请求参数

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

实验室所属的环境。

  • Daily:日常环境
  • Pre:预发环境
  • Prod:生产环境
Daily
SceneIdstring

场景 ID,可通过接口 ListScenes 获取。

3
Statusstring

状态。

  • Offline:未上线
  • Online:已上线
Offline
InstanceIdstring

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

pairec-test1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

1C0898E5-9220-5443-B2D9-445FF0688215
TotalCountlong

列表内元素总数。

10
Laboratoriesarray<object>

实验室列表。

Laboratoriesobject
LaboratoryIdstring

实验室 ID。

3
SceneIdstring

场景 ID。

3
Namestring

实验室名称。

laboratory1
Descriptionstring

实验室描述。

This is a test.
DebugUsersstring

调试用户。

user1,user2,user3
DebugCrowdIdstring

调试人群 ID。

3
BucketCountinteger

分桶数量。

100
Bucketsstring

分配桶号。

1,2,3,10-20
BucketTypestring

分桶方式。

  • Uid-UID:分桶(默认)
  • UidHash:UID 哈希
  • Filter:过滤条件分桶
Filter
Filterstring

过滤条件。

filter=xxx
Environmentstring

运行环境

  • Daily:日常环境
  • Pre:预发环境
  • Prod:生产环境
Daily
Typestring

实验室类型

  • Base
  • NonBase
Base
Statusstring

状态。

  • Offline:未上线
  • Online:已上线
Offline
CrowdIdstring

人群 ID。

3

示例

正常返回示例

JSON格式

{
  "RequestId": "1C0898E5-9220-5443-B2D9-445FF0688215",
  "TotalCount": 10,
  "Laboratories": [
    {
      "LaboratoryId": 3,
      "SceneId": 3,
      "Name": "laboratory1",
      "Description": "This is a test.",
      "DebugUsers": "user1,user2,user3",
      "DebugCrowdId": 3,
      "BucketCount": 100,
      "Buckets": "1,2,3,10-20",
      "BucketType": "Filter",
      "Filter": "filter=xxx",
      "Environment": "Daily",
      "Type": "Base",
      "Status": "Offline",
      "CrowdId": 3
    }
  ]
}

错误码

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