GetExperiment-阿里云帮助中心

Retrieves the details of an experiment.

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:GetExperiment

get

*Experiment

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

None

Request parameters

Parameter	Type	Required	Description	Example
ExperimentId	integer	Yes	The experiment ID.	234
ResourceGroupId	string	No	Resource Group Id	rg-sdsmfg23

Response elements

Element	Type	Description	Example
	object	The experiment object.
Data	object	The data.
Task	object	The experiment task.
TaskId	integer	Task ID	167420
CreateTime	integer	Creation time	2024-03-05 18:24:08
UpdateTime	integer	Update time	2024-03-05 18:24:08
StartTime	integer	Start time	2024-03-05 18:24:08
EndTime	integer	End time	2024-03-05 18:34:08
Params	object	Experiment parameters
	string	Environment parameters	{}
Scene	string	Scene	baseline
Status	string	Status	success
Workload	object	The workload information.
WorkloadId	integer	Workload ID	13
WorkloadName	string	Workload name	test
WorkloadDescription	string	Workload description	test
WorkloadType	string	Workload name	AI
Family	string	Workload cluster, AI, GPU	AI
Scene	string	Workload usage scenario	NLP-LLM
Scope	string	Scope	common
JobKind	string	JobKind	PyTorchJob
DefaultCpuPerWorker	integer	Default CPU allocation	90
DefaultGpuPerWorker	integer	Default GPU allocation	8
DefaultMemoryPerWorker	integer	Default memory (GB) allocation	500
DefaultShareMemory	integer	Default shared memory (GB) allocation	500
ParamSettings	array<object>	Parameter settings
	object
ParamName	string	Parameter name	ITERATION
ParamDesc	string	Parameter description	number
ParamValue	string	Parameter value	100
DefaultValue	string	Default parameter value	100
ParamRegex	string	Parameter regular expression	[0-9]+
ParamType	string	Parameter type	number
StaticConfig	object	Static configuration
FrameWork	string	Framework	pyTorch
SoftwareStack	string	Software stack	python
Os	string	Operating system	linux
Parameters	string	Number of parameters	7B
VersionId	integer	Version ID	1
Resource	object	The cluster information.
ResourceId	integer	Cluster ID	189
ResourceName	string	Cluster name	ecs.r8y.4xlarge
CpuCoreLimit	integer	Used CPU	90
GpuLimit	integer	Used GPU	8
MemoryLimit	integer	Used memory	500
MaxGpu	integer	Used memory	8
MaxCpuCore	integer	Used memory	90
MaxMemory	integer	Used memory	500
UserAccessParam	object	User authorization parameters
AccessId	string	User ID	dev
AccessKey	string	User key	test
WorkspaceId	string	Workspace ID	123434542498
Endpoint	string	Endpoint	test
MachineType	object	Instance type
MemoryInfo	string	Memory information	32x 64GB DDR4 3200 Memory
Type	string	Type	Public
BondNum	integer	Number of network bonds	5
NodeCount	integer	Number of nodes	1
CpuInfo	string	CPU information	2x Intel Icelake 8369B 32C CPU
NetworkInfo	string	Network information	1x 100Gbps DP NIC for VPC \n 4x 100Gbps DP RoCE NIC
GpuInfo	string	GPU information	8x NVIDIA SXM4 80GB A100 GPU
DiskInfo	string	Disk information	2x 480GB SATA SSD \n 4x 3.84TB NVMe SSD
NetworkMode	string	Network mode	2
Name	string	Specification name	efg1.nvga1n
ResourceNodes	array<object>	Resource node list
	object
NodeName	string	Node name	InputCheck
ExperimentId	integer	The experiment ID.	1726882991828688898
CreateTime	integer	The creation time.	2024-11-29 02:16:35
UpdateTime	integer	The update time.	2024-11-29 02:16:35
ExperimentName	string	The experiment name.	test
ExperimentType	string	The experiment type.	AI
ResourceName	string	The resource name.	cifnews-guoyuan
WorkloadName	string	The workload name.	test
StartTime	string	The task start time.	2024-11-29 02:16:35
EndTime	string	The task end time.	2024-11-29 02:26:35
Status	string	The status.	RUNNING
Results	object	The task results.
ExperimentId	integer	Parameter name	1748274952976261121
Duration	number	Duration	764
SecondsPerIteration	number	Seconds per iteration	1000
SamplesPerSecond	number	Samples Per Second	10
Mfu	number	MFU	54.2
WarningWorker	array<object>	Warning worker
	object
ExperimentId	integer	Experiment ID	9
Hostname	string	Service address	whza008403
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	true
WarningMsg	string	Alarm message	warging message
ErrorFlag	boolean	Whether there is an error	true
ErrorMsg	string	Error message	error message
Tflops	number	TFLOPS value	14
SamplesPerSecond	number	Throughput	15
ErrorWorker	array<object>	Error node
	object
ExperimentId	integer	Experiment ID	97
Hostname	string	Service address	60.188.98.209
PodName	string	Pod name.	hzs-forge-sdxl-online-7ff4d86444-pc95h
GpuNum	integer	Number of GPUs	8
GpuName	string	GPU name	8x OAM 810 GPU
WarningFlag	boolean	Whether there is a warning	false
WarningMsg	string	Warning message	warning message
ErrorFlag	boolean	error flag	true
ErrorMsg	string	error message	Connection reset
Tflops	number	TFLOPS	12
SamplesPerSecond	number	Samples Per Second	23
WarningBoundList	array<object>	Warning bound list
	object
Iteration	integer	Iteration	10
Upper	number	UPPER	56
Lower	number	LOWER	14
TaskIndividualResultList	array<object>	Task individual result list
	object
ExperimentId	integer	实验 ID。	48
Hostname	string	节点主机名称。	p-jt-waf-app1
PodName	string	Pod 名称。	fluxserv-6fc89b45cf-w8wq6
GpuNum	integer	Number of GPUs	8
GpuName	string	GPU name	8x OAM 810 GPU
WarningFlag	boolean	Whether there is a warning	false
WarningMsg	string	Warning message	warning message
ErrorFlag	boolean	Whether there is an error	false
ErrorMsg	string	Error message	error message
Tflops	number	TFLOPS value	16
SamplesPerSecond	number	Throughput	28
TaskIndividualResultMap	object	Invalid task results
	array<object>	Result object
	object
ExperimentId	integer	Experiment ID	54
Hostname	string	Host IP	p-jt-waf-app1
PodName	string	Pod name	fluxserv-6fc89b45cf-w8wq6
GpuNum	integer	GPU 数量	8
GpuName	string	GPU 名称	8x OAM 810 GPU
WarningFlag	boolean	Whether there is a warning	false
WarningMsg	string	Warning message	warning message
ErrorFlag	boolean	Whether there is an error	false
ErrorMsg	string	Error message	error message
Tflops	number	TFLOPS value	45
SamplesPerSecond	number	Throughput	23
SetParams	object	The workload parameters used for running.
	string	参数	{}
GetParams	object	The parsed workload parameters.
	string	参数	{}
EnvParams	object	The runtime environment parameters.
CpuPerWorker	integer	CPU allocation number	90
GpuPerWorker	integer	GPU allocation number	8
MemoryPerWorker	integer	Memory Per Worker	500
ShareMemory	integer	Share Memory	500
WorkerNum	integer	Worker number	1
CudaVersion	string	cudaVersion	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	p-jt-waf-app1
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	params	{}
RequestId	string	The request ID.	E67E2E4C-2B47-5C55-AA17-1D771E070AEF
AccessDeniedDetail	string	The access denied details.	{}
TotalCount	integer	The total count.	0

Examples

Success response

JSON format

{
  "Data": {
    "Task": {
      "TaskId": 167420,
      "CreateTime": 0,
      "UpdateTime": 0,
      "StartTime": 0,
      "EndTime": 0,
      "Params": {
        "key": "{}"
      },
      "Scene": "baseline",
      "Status": "success"
    },
    "Workload": {
      "WorkloadId": 13,
      "WorkloadName": "test",
      "WorkloadDescription": "test",
      "WorkloadType": "AI",
      "Family": "AI",
      "Scene": "NLP-LLM",
      "Scope": "common",
      "JobKind": "PyTorchJob",
      "DefaultCpuPerWorker": 90,
      "DefaultGpuPerWorker": 8,
      "DefaultMemoryPerWorker": 500,
      "DefaultShareMemory": 500,
      "ParamSettings": [
        {
          "ParamName": "ITERATION",
          "ParamDesc": "number",
          "ParamValue": "100",
          "DefaultValue": "100",
          "ParamRegex": "[0-9]+",
          "ParamType": "number"
        }
      ],
      "StaticConfig": {
        "FrameWork": "pyTorch",
        "SoftwareStack": "python",
        "Os": "linux",
        "Parameters": "7B"
      },
      "VersionId": 1
    },
    "Resource": {
      "ResourceId": 189,
      "ResourceName": "ecs.r8y.4xlarge",
      "CpuCoreLimit": 90,
      "GpuLimit": 8,
      "MemoryLimit": 500,
      "MaxGpu": 8,
      "MaxCpuCore": 90,
      "MaxMemory": 500,
      "UserAccessParam": {
        "AccessId": "dev",
        "AccessKey": "test",
        "WorkspaceId": "123434542498",
        "Endpoint": "test"
      },
      "MachineType": {
        "MemoryInfo": "32x 64GB DDR4 3200 Memory",
        "Type": "Public",
        "BondNum": 5,
        "NodeCount": 1,
        "CpuInfo": "2x Intel Icelake 8369B 32C CPU",
        "NetworkInfo": "1x 100Gbps DP NIC for VPC \\n 4x 100Gbps DP RoCE NIC",
        "GpuInfo": "8x NVIDIA SXM4 80GB A100 GPU",
        "DiskInfo": "2x 480GB SATA SSD \\n 4x 3.84TB NVMe SSD",
        "NetworkMode": "2",
        "Name": "efg1.nvga1n"
      },
      "ResourceNodes": [
        {
          "NodeName": "InputCheck"
        }
      ]
    },
    "ExperimentId": 1726882991828689000,
    "CreateTime": 0,
    "UpdateTime": 0,
    "ExperimentName": "test",
    "ExperimentType": "AI",
    "ResourceName": "cifnews-guoyuan",
    "WorkloadName": "test",
    "StartTime": "2024-11-29 02:16:35",
    "EndTime": "2024-11-29 02:26:35",
    "Status": "RUNNING",
    "Results": {
      "ExperimentId": 1748274952976261000,
      "Duration": 764,
      "SecondsPerIteration": 1000,
      "SamplesPerSecond": 10,
      "Mfu": 54.2,
      "WarningWorker": [
        {
          "ExperimentId": 9,
          "Hostname": "whza008403",
          "PodName": "fluxserv-6fc89b45cf-w8wq6",
          "GpuNum": 8,
          "GpuName": "8x OAM 810 GPU",
          "WarningFlag": true,
          "WarningMsg": "warging message",
          "ErrorFlag": true,
          "ErrorMsg": "error message",
          "Tflops": 14,
          "SamplesPerSecond": 15
        }
      ],
      "ErrorWorker": [
        {
          "ExperimentId": 97,
          "Hostname": "60.188.98.209",
          "PodName": "hzs-forge-sdxl-online-7ff4d86444-pc95h",
          "GpuNum": 8,
          "GpuName": "8x OAM 810 GPU",
          "WarningFlag": false,
          "WarningMsg": "warning message",
          "ErrorFlag": true,
          "ErrorMsg": "Connection reset",
          "Tflops": 12,
          "SamplesPerSecond": 23
        }
      ],
      "WarningBoundList": [
        {
          "Iteration": 10,
          "Upper": 56,
          "Lower": 14
        }
      ],
      "TaskIndividualResultList": [
        {
          "ExperimentId": 48,
          "Hostname": "p-jt-waf-app1",
          "PodName": "fluxserv-6fc89b45cf-w8wq6",
          "GpuNum": 8,
          "GpuName": "8x OAM 810 GPU",
          "WarningFlag": false,
          "WarningMsg": "warning message",
          "ErrorFlag": false,
          "ErrorMsg": "error message",
          "Tflops": 16,
          "SamplesPerSecond": 28
        }
      ],
      "TaskIndividualResultMap": {
        "key": [
          {
            "ExperimentId": 54,
            "Hostname": "p-jt-waf-app1\n",
            "PodName": "fluxserv-6fc89b45cf-w8wq6",
            "GpuNum": 8,
            "GpuName": "8x OAM 810 GPU\n",
            "WarningFlag": false,
            "WarningMsg": "warning message",
            "ErrorFlag": false,
            "ErrorMsg": "error message",
            "Tflops": 45,
            "SamplesPerSecond": 23
          }
        ]
      }
    },
    "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": "p-jt-waf-app1",
          "TotalCPU": 90,
          "TotalGPU": 8,
          "TotalMemory": 500,
          "RequestCPU": 90,
          "RequestGPU": 8,
          "RequestMemory": 500
        }
      ],
      "ExtendParam": {
        "key": "{}"
      }
    }
  },
  "RequestId": "E67E2E4C-2B47-5C55-AA17-1D771E070AEF",
  "AccessDeniedDetail": "{}",
  "TotalCount": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotFound	not found.	Data does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.