GetActionPlan-阿里云帮助中心

Queries the details of an execution plan.

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

ehpc:GetActionPlan

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ActionPlanId	string	No	ID of the execution plan.	ap-hz036ubmx2qmw93k****

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	ID of the request.	896D338C-E4F4-41EC-A154-D605E5DE****
ActionPlanId	string	ID of the execution plan.	ap-hz036ubmx2qmw93k****
ActionPlanName	string	Name of the execution plan.	TestActionPlan
CreateTime	string	Time when the execution plan was created.	2025-08-10 18:28:05
UpdateTime	string	Last time the execution plan was modified.	2025-08-10 18:28:05
AppId	string	ID of the application.	ci-vm-rYfypJKwlN9Y
PrologScript	string	Prologue script. Must be Base64-encoded.	bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
ResourceType	string	Type of target resource for the execution plan. Valid values are: VCpuCapacity: vCPU capacity ExecutorCapacity: number of executor nodes	VCpuCapacity
DesiredCapacity	number	Target resource size for the execution plan. If ResourceType is VCpuCapacity, this value represents the target vCPU count.	1000
TotalCapacity	number	Current resource size managed by the execution plan.	1000
Status	string	Status of the execution plan. Valid values are: Active: The execution plan is active and dynamically manages Instant jobs. Inactive: The execution plan is inactive and no longer manages Instant jobs. Deleting: The execution plan is being deleted. You cannot modify parameters during this state.	Active
Resources	array<object>	List of resource configurations for the execution plan's runtime environment.
	object	Resource configuration for the execution plan's runtime environment.
Cores	number	Number of CPUs in the runtime environment.	64
Memory	number	Memory size in the runtime environment, in GiB.	128
Regions	array<object>	List of region-specific resource configurations for the execution plan's runtime environment.
	object	Region-specific resource configuration for the execution plan's runtime environment.
RegionId	string	ID of the region.	cn-hangzhou
VSwitchIds	array	List of vSwitches available to the execution plan in this region.
	string	ID of the vSwitch.	vsw-bp14v5eikr8wrgoqje7hr
SecurityGroupIds	array	List of security groups available to the execution plan in this region.
	string	vSwitch ID.	sg-uf6j4pp39x9k3x05c3vw
AllocationSpec	string	Resource type.	Standard
Level	string	Computing power level.	General
IntervalMinutes	integer		60

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "ActionPlanId": "ap-hz036ubmx2qmw93k****",
  "ActionPlanName": "TestActionPlan",
  "CreateTime": "2025-08-10 18:28:05",
  "UpdateTime": "2025-08-10 18:28:05\n",
  "AppId": "ci-vm-rYfypJKwlN9Y",
  "PrologScript": "bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==",
  "ResourceType": "VCpuCapacity",
  "DesiredCapacity": 1000,
  "TotalCapacity": 1000,
  "Status": "Active",
  "Resources": [
    {
      "Cores": 64,
      "Memory": 128
    }
  ],
  "Regions": [
    {
      "RegionId": "cn-hangzhou",
      "VSwitchIds": [
        "vsw-bp14v5eikr8wrgoqje7hr"
      ],
      "SecurityGroupIds": [
        "sg-uf6j4pp39x9k3x05c3vw"
      ]
    }
  ],
  "AllocationSpec": "Standard",
  "Level": "General",
  "IntervalMinutes": 60
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExisted.ActionPlan	The specified action plan does not exist.	The specified execution plan does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.