API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (EhpcInstant/2023-07-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Execution Plan
|
API |
Title |
Description |
| CreateActionPlan | CreateActionPlan | Creates an E-HPC execution plan. |
| UpdateActionPlan | UpdateActionPlan | Adjust the resource scale of the execution plan or modify the execution status |
| ListActionPlans | ListActionPlans | Queries the list of execution plans. |
| ListActionPlanActivities | ListActionPlanActivities | Queries the execution status of an execution plan. |
| GetActionPlan | GetActionPlan | Queries the details of an execution plan. |
| DeleteActionPlan | DeleteActionPlan | Delete an execution plan |
Mirror
|
API |
Title |
Description |
| GetAppVersions | GetAppVersions | Obtains the application version list. |
| SynchronizeApp | SynchronizeApp | Application cross-region synchronization |
Operation
|
API |
Title |
Description |
| GetJob | GetJob | Retrieves job execution details. |
| DeleteJobs | DeleteJobs | Deletes one or more jobs from a specified cluster. |
| ListExecutors | ListExecutors | Queries information about global executors. |
| ListExecutorEvents | ListExecutorEvents | Queries the running event list of one or more executers. |
| DeleteJobRecords | DeleteJobRecords | Deletes one or more job records that are in the final state from a specified cluster. |
| DescribeJobResults | DescribeJobResults | Retrieves the logs for a job. |
Monitoring
|
API |
Title |
Description |
| DescribeJobMetricData | DescribeJobMetricData | You can query the monitoring time series dataset of a job by specifying the job array index and query metric parameters. |
| DescribeJobMetricLast | DescribeJobMetricLast | Queries all instant monitoring metrics in the job array list by specifying a specific job array index list. |
resource pool
|
API |
Title |
Description |
| CreatePool | CreatePool | Creates a pool. |
| UpdatePool | UpdatePool | Updates the configuration of a resource pool. |
| GetPool | GetPool | Retrieves the details of a specified resource pool. |
| ListPools | ListPools | Lists resource pools. |
| DeletePool | DeletePool | You can execute this statement to delete a resource pool. |
Others
|
API |
Title |
Description |
| AddImage | AddImage | Add a custom image. |
| CreateJob | CreateJob | Creates an E-HPC Instant job. |
| GetImage | GetImage | Get image details. |
| GetJobRecordDuration | GetJobRecordDuration | Retrieves the job record retention period. |
| ListImages | ListImages | Queries the image list. |
| ListJobExecutors | ListJobExecutors | Retrieves information about job executors. |
| ListJobs | ListJobs | Returns a list of jobs. |
| ListTagResources | ListTagResources | Queries the tags that are bound to one or more Instant resources. |
| RemoveImage | RemoveImage | Remove a custom image |
| TagResources | TagResources | Create and bind tags to Instant resource list |
| UnTagResources | UnTagResources | Unbind tags from Instant resource list. If the tag is not bound to other resources, the tag is automatically deleted. |
| UpdateJobRecordDuration | UpdateJobRecordDuration | Updates the job record duration. |