CreateActionPlan-阿里云帮助中心

Creates an E-HPC execution plan.

Operation description

Before you call this operation, ensure that you understand the billing methods and pricing of E-HPC Instant.

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

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ActionPlanName	string	No	The name of the execution plan.	TestActionPlan
AppId	string	No	The application ID.	ci-vm-rYfypJKwlN9Y
Script	string	No	The script to run the job. The script must be Base64-encoded.	bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
PrologScript	string	No	The pre-execution script. The script must be Base64-encoded.	bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==
ResourceType	string	No	The type of resource for the execution target. The value can be the vCPU capacity or the number of executor nodes. Valid values: VCpuCapacity: vCPU capacity ExecutorCapacity: number of executor nodes	VCpuCapacity
DesiredCapacity	number	No	The desired size of the resource for the execution plan. For example, if you set ResourceType to VcpuCapacity, this parameter specifies the number of vCPUs that you want to maintain for the execution plan.	1000
Resources	array<object>	No	A list of resource configurations for the runtime environment of the execution plan. You can specify 1 to 10 resource configurations.	1000
	object	No	The resource configuration for the runtime environment of the execution plan.
Cores	number	No	The number of vCPUs for the runtime environment.	2
Memory	number	No	The memory size of the runtime environment. Unit: GiB.	4
Regions	array<object>	No	A list of regional resource configurations for the runtime environment of the execution plan.
	object	No	The regional resource configuration for the runtime environment of the execution plan.
RegionId	string	No	The region ID.	cn-hangzhou
VSwitchIds	array	No	A list of vSwitches that are available for the execution plan in the region. You can specify 0 to 5 vSwitches.
	string	No	The vSwitch ID. You can call the DescribeVSwitches operation to query information about available vSwitches.	vsw-8vb4m54nq1hwtxxda****
SecurityGroupId	array	No	A list of security groups that are available for the execution plan in the region. You can specify 0 to 5 security groups.
	string	No	The security group ID. You can call the DescribeSecurityGroups operation to query information about available security groups.	sg-2zeh9711f6c04bkr****
SecurityGroupIds	array	No	A list of security group IDs. You can call the DescribeSecurityGroups operation to query information about available security groups.
	string	No	The security group ID. You can call the DescribeSecurityGroups operation to query information about available security groups.	sg-uf6j4pp39x9k3x05c3vw
AllocationSpec	string	No	The resource type. Standard: Standard. Dedicated: Dedicated. This type is available only to users in the whitelist. Economic: Economy. This type is available only to users in the whitelist.	Standard
Level	string	No	The computing power level. This parameter is valid only when you set AllocationSpec to Economic. The following types are supported: General: General-purpose. Performance: Compute-optimized. Default value: General	General

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	896D338C-E4F4-41EC-A154-D605E5DE****
ActionPlanId	string	The execution plan ID.	ap-hz036ubmx2qmw93k****

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "ActionPlanId": "ap-hz036ubmx2qmw93k****"
}

Error codes

HTTP status code	Error code	Error message	Description
406	QuotaExceeded.ActionPlan	The number of action plans in the current account has exceeded quota.	The number of execution plans under the current account exceeds the limit of execution plans under the user account.

See for a complete list.

Release notes

See Release Notes for a complete list.