Filter & Retrieve Experiment Lists via ListExperiments API - Platform For AI - Alibaba Cloud - Intelligent Computing LINGJUN

Retrieves a list of experiments.

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

eflo:ListExperiments

list

*Experiment

acs:eflo:{#regionId}:{#accountId}:experiment/*

None

Request parameters

Parameter	Type	Required	Description	Example
PlanId	integer	No	The plan ID.	189
Order	integer	No	The order.	1
ResourceGroupId	string	No	The resource group ID.	rg-uo8f26cpmo

Response elements

Element	Type	Description	Example
	object	The list of experiment objects.
Data	array<object>	The data.
	array<object>
ExperimentId	integer	The experiment ID.	1684537476910997506
CreateTime	integer	The time when the experiment was created.	2024-10-22 10:18:10
UpdateTime	integer	The time when the experiment was last updated.	2024-10-22 10:18:10
ExperimentName	string	The experiment name.	test
ExperimentType	string	The experiment type.	AI
ResourceName	string	The resource name.	ecs.r8y.4xlarge
WorkloadName	string	The workload name.	test
StartTime	string	The time when the task started.	2024-10-22 10:18:10
EndTime	string	The time when the task ended.	2024-10-22 10:28:10
Status	string	The status.	RUNNING
Results	object	The task result.
ExperimentId	integer	Parameter name	440
Duration	number	Duration	20
SecondsPerIteration	number	Seconds per iteration	89
SamplesPerSecond	number	Samples per second	10
Mfu	number	MFU	34
WarningWorker	array<object>	Warning worker
	object
ExperimentId	integer	Experiment ID	113
Hostname	string	Host IP	101.66.165.102
PodName	string	Pod name	hzs-forge-sdxl-online-7ff4d86444-pc95h
GpuNum	integer	Number of GPUs	90
GpuName	string	GPU name	8x OAM 810 GPU
WarningFlag	boolean	Whether there is an alarm	false
WarningMsg	string	Alarm message	warning msg
ErrorFlag	boolean	Whether there is an error	false
ErrorMsg	string	Error message	error msg
Tflops	number	TFLOPS value	43
SamplesPerSecond	number	Throughput	53
ErrorWorker	array<object>	Error nodes
	object	Error nodes
ExperimentId	integer	Experiment ID	176
Hostname	string	Host IP	etcd_cluster_c0n2
PodName	string	Pod name	fluxserv-6fc89b45cf-w8wq6
GpuNum	integer	Number of GPUs	8
GpuName	string	GPU name	8x OAM 810 GPU
WarningFlag	boolean	Whether there is an alarm	false
WarningMsg	string	Alarm information	warning msg
ErrorFlag	boolean	Whether there is an error	false
ErrorMsg	string	Error information	error msg
Tflops	number	TFLOPS value	42
SamplesPerSecond	number	Throughput	65
SetParams	object	The workload parameters that were set for the run.
	string	参数	{}
GetParams	object	The parsed workload parameters.
	string	参数	{}
EnvParams	object	The environment parameters for the run.
CpuPerWorker	integer	Number of CPUs allocated	90
GpuPerWorker	integer	Number of GPUs allocated	8
MemoryPerWorker	integer	Amount of memory (GB) allocated	500
ShareMemory	integer	Amount of shared memory (GB) allocated	500
WorkerNum	integer	Number of nodes	1
CudaVersion	string	CUDA version	1.0.0
NCCLVersion	string	NCCL version	1.0.0
GpuDriverVersion	string	GPU driver version	1.0.0
PyTorchVersion	string	PyTorch version	1.0.0
ResourceNodes	array<object>	Specified nodes
	object
NodeName	string	Node name	lingj1xxnjt1k4nv-mg18v52pydyuumae-0
TotalCPU	integer	Total CPU	90
TotalGPU	integer	Total GPU	8
TotalMemory	integer	Total memory	500
RequestCPU	integer	Requested CPU	90
RequestGPU	integer	Requested GPU	8
RequestMemory	integer	Requested memory	500
ExtendParam	object	Additional parameters
	string	Parameter	{}
RequestId	string	The request ID.	5514CB39-B7C0-5B89-8534-2DE1E0F2B7AB
AccessDeniedDetail	string	The access denied details.	{}
TotalCount	integer	The total number of entries returned.	0

Examples

Success response

JSON format

{
  "Data": [
    {
      "ExperimentId": 1684537476910997500,
      "CreateTime": 0,
      "UpdateTime": 0,
      "ExperimentName": "test",
      "ExperimentType": "AI",
      "ResourceName": "ecs.r8y.4xlarge",
      "WorkloadName": "test",
      "StartTime": "2024-10-22 10:18:10",
      "EndTime": "2024-10-22 10:28:10",
      "Status": "RUNNING",
      "Results": {
        "ExperimentId": 440,
        "Duration": 20,
        "SecondsPerIteration": 89,
        "SamplesPerSecond": 10,
        "Mfu": 34,
        "WarningWorker": [
          {
            "ExperimentId": 113,
            "Hostname": "101.66.165.102",
            "PodName": "hzs-forge-sdxl-online-7ff4d86444-pc95h",
            "GpuNum": 90,
            "GpuName": "8x OAM 810 GPU",
            "WarningFlag": false,
            "WarningMsg": "warning msg",
            "ErrorFlag": false,
            "ErrorMsg": "error msg",
            "Tflops": 43,
            "SamplesPerSecond": 53
          }
        ],
        "ErrorWorker": [
          {
            "ExperimentId": 176,
            "Hostname": "etcd_cluster_c0n2",
            "PodName": "fluxserv-6fc89b45cf-w8wq6",
            "GpuNum": 8,
            "GpuName": "8x OAM 810 GPU",
            "WarningFlag": false,
            "WarningMsg": "warning msg",
            "ErrorFlag": false,
            "ErrorMsg": "error msg",
            "Tflops": 42,
            "SamplesPerSecond": 65
          }
        ]
      },
      "SetParams": {
        "key": "{}"
      },
      "GetParams": {
        "key": "{}"
      },
      "EnvParams": {
        "CpuPerWorker": 90,
        "GpuPerWorker": 8,
        "MemoryPerWorker": 500,
        "ShareMemory": 500,
        "WorkerNum": 1,
        "CudaVersion": "1.0.0",
        "NCCLVersion": "1.0.0",
        "GpuDriverVersion": "1.0.0",
        "PyTorchVersion": "1.0.0",
        "ResourceNodes": [
          {
            "NodeName": "lingj1xxnjt1k4nv-mg18v52pydyuumae-0",
            "TotalCPU": 90,
            "TotalGPU": 8,
            "TotalMemory": 500,
            "RequestCPU": 90,
            "RequestGPU": 8,
            "RequestMemory": 500
          }
        ],
        "ExtendParam": {
          "key": "{}"
        }
      }
    }
  ],
  "RequestId": "5514CB39-B7C0-5B89-8534-2DE1E0F2B7AB",
  "AccessDeniedDetail": "{}",
  "TotalCount": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.