ListWorkloads-阿里云帮助中心

Queries a list of workloads.

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

list

*Workload

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

None

Request parameters

Parameter	Type	Required	Description	Example
Scope	string	No	Scope	common

Response elements

Element	Type	Description	Example
	object	Result
Data	array<object>	Data
	array<object>
WorkloadId	integer	Workload ID	13
WorkloadName	string	Workload Name	test
WorkloadDescription	string	Workload Description	test
WorkloadType	string	Workload Type	AI
Family	string	Workload family. Valid values: Cluster, AI, and GPU.	AI
Scene	string	Workload usage scenario.	NLP-LLM
Scope	string	Scope of workload usage.	common
JobKind	string	Training job type.	PyTorchJob
DefaultCpuPerWorker	integer	Default number of CPUs per worker.	90
DefaultGpuPerWorker	integer	Default number of GPUs per worker.	8
DefaultMemoryPerWorker	integer	Default memory per worker, in GB.	500
DefaultShareMemory	integer	Default shared memory per worker, in GB.	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	Validation regex for the parameter value.	[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 model parameters.	7B
VersionId	integer	Version ID	1
RequestId	string	Request ID	4AC08332-436C-57A3-9FBA-26772B1A9901
AccessDeniedDetail	string	Access denied details.	{}
TotalCount	integer	Total number of workloads.	1

Examples

Success response

JSON format

{
  "Data": [
    {
      "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
    }
  ],
  "RequestId": "4AC08332-436C-57A3-9FBA-26772B1A9901",
  "AccessDeniedDetail": "{}",
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.