GetExperimentPlan-阿里云帮助中心

Queries the details of a specified experiment plan, including pipeline configuration, resource allocation, and environment parameters.

Try it now

You can OpenAPI Explorer directly Runningthis API, saving you the trouble of calculating signatures. Successfulafter, OpenAPI Explorercan automatically generateSDKcode samples.

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

get

*ExperimentPlan

acs:eflo:{#regionId}:{#accountId}:experimentplan/{#ExperimentPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
PlanId	integer	Yes	The plan ID.	189

Response elements

Parameter	Type	Description	Example
	object	The response object.
Data	object	The returned data.
PlanId	integer	The plan ID.	189
CreateTime	string	The time when the plan was created.	2024-07-07 02:08:54
UpdateTime	string	The time when the plan was last updated.	2024-07-07 02:08:54
TemplateId	integer	The ID of the associated experiment plan template.	2162
TemplateName	string	The name of the associated experiment plan template.	MM
ResourceId	integer	The associated resource ID.	260860230684
PlanPipeline	array<object>	The experiment plan pipeline.
	object
WorkloadId	integer	The workload ID.	14
WorkloadName	string	The workload name.	test
ResourceId	integer	The resource ID.	36
ResourceName	string	The resource name.	GPU
Scene	string	The scenario. For example, "baseline".	baseline
SettingParams	object	The configured workload parameters.
	string	The parameter.	{}
EnvParams	object	The configured environment parameters.
CpuPerWorker	integer	The number of CPUs allocated per worker.	90
GpuPerWorker	integer	The number of GPUs allocated per worker.	8
MemoryPerWorker	integer	The amount of memory allocated per worker. Unit: GB.	500
ShareMemory	integer	The amount of shared memory allocated. Unit: GB.	500
WorkerNum	integer	The number of worker nodes.	1
CudaVersion	string	The CUDA version.	1.0.0
NCCLVersion	string	The NCCL version.	1.0.0
GpuDriverVersion	string	The GPU driver version.	1.0.0
PyTorchVersion	string	The PyTorch version.	1.0.0
ResourceNodes	array<object>	The list of specified resource nodes.
	object
NodeName	string	The node name.	ods_galaxy_gateway_tickets
TotalCPU	integer	The total number of CPUs.	90
TotalGPU	integer	The total number of GPUs.	8
TotalMemory	integer	The total amount of memory.	500
RequestCPU	integer	The number of requested CPUs on this node.	90
RequestGPU	integer	The number of requested GPUs on this node.	8
RequestMemory	integer	The amount of requested memory on this node.	500
ExtendParam	object	The extended parameters.
	string	The parameter.	{}
PipelineOrder	integer	The execution order of this pipeline stage.	1
ResourceGroupId	string	The resource group ID.	rg-acfmvmpzi7lmxhq
Tags	array<object>	The list of tags.
	object	The tag information.
TagKey	string	The tag key.	acs:testLXP:test-quota40-19
TagValue	string	The tag value.	000088aabb0019e4
RequestId	string	The request ID.	6DBAC169-93D1-5DCD-8109-30FB623B3197
AccessDeniedDetail	string	The details about access denial, if applicable.	{}
TotalCount	integer	The total number of queries.	0

Examples

Success response

JSON format

{
  "Data": {
    "PlanId": 189,
    "CreateTime": "2024-07-07 02:08:54",
    "UpdateTime": "2024-07-07 02:08:54",
    "TemplateId": 2162,
    "TemplateName": "MM",
    "ResourceId": 260860230684,
    "PlanPipeline": [
      {
        "WorkloadId": 14,
        "WorkloadName": "test",
        "ResourceId": 36,
        "ResourceName": "GPU",
        "Scene": "baseline",
        "SettingParams": {
          "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": "ods_galaxy_gateway_tickets",
              "TotalCPU": 90,
              "TotalGPU": 8,
              "TotalMemory": 500,
              "RequestCPU": 90,
              "RequestGPU": 8,
              "RequestMemory": 500
            }
          ],
          "ExtendParam": {
            "key": "{}"
          }
        },
        "PipelineOrder": 1
      }
    ],
    "ResourceGroupId": "rg-acfmvmpzi7lmxhq",
    "Tags": [
      {
        "TagKey": "acs:testLXP:test-quota40-19",
        "TagValue": "000088aabb0019e4"
      }
    ]
  },
  "RequestId": "6DBAC169-93D1-5DCD-8109-30FB623B3197",
  "AccessDeniedDetail": "{}",
  "TotalCount": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotFound	not found.	The specified data does not exist.

See Error Codes for a complete list.

Release notes

See change details for a complete list.