ListLaboratories-阿里云帮助中心

Retrieves the laboratories in a specified scene.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pairec:ListLaboratories

list

*All Resource

*

None

Request syntax

GET /api/v1/laboratories HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Environment	string	No	The laboratory environment. `Daily`: the daily environment `Pre`: the pre-production environment `Prod`: the production environment	Daily
SceneId	string	Yes	The ID of the scene. You can obtain this ID by calling the `ListScenes` API.	3
Status	string	No	The laboratory status. `Offline`: The laboratory is offline. `Online`: The laboratory is online.	Offline
InstanceId	string	Yes	The ID of the instance. You can obtain this ID by calling the `ListInstances` API.	pairec-test1

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	1C0898E5-9220-5443-B2D9-445FF0688215
TotalCount	integer	The total number of laboratories.	10
Laboratories	array<object>	A list of laboratories.
	object
LaboratoryId	string	The laboratory ID.	3
SceneId	string	The scene ID.	3
Name	string	The laboratory name.	laboratory1
Description	string	The laboratory description.	This is a test.
DebugUsers	string	The debug users, separated by commas.	user1,user2,user3
DebugCrowdId	string	The debug crowd ID.	3
BucketCount	integer	The bucket count.	100
Buckets	string	The assigned buckets, specified as numbers or ranges separated by commas.	1,2,3,10-20
BucketType	string	The bucketing method. `Uid-UID`: Bucketing by UID (default) `UidHash`: Bucketing by UID hash `Filter`: Bucketing by a filter condition	Filter
Filter	string	The filter condition.	filter=xxx
Environment	string	The laboratory environment. `Daily`: the daily environment `Pre`: the pre-production environment `Prod`: the production environment	Daily
Type	string	The laboratory type. `Base`: A base laboratory. `NonBase`: A non-base laboratory.	Base
Status	string	The laboratory status. `Offline`: The laboratory is offline. `Online`: The laboratory is online.	Offline
CrowdId	string	The crowd ID.	3

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.