API标准及多语言预置SDK
本产品（EhpcInstant/2023-07-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
执行计划
|
API |
标题 |
API概述 |
| CreateActionPlan | 创建执行计划 | 创建一个E-HPC的执行计划。 |
| UpdateActionPlan | 更新执行计划。 | 调整执行计划资源规模或执行修改状态 |
| ListActionPlans | 查询执行计划列表。 | 查询执行计划列表。 |
| ListActionPlanActivities | 查询执行计划的执行情况。 | 查询执行计划的执行情况。 |
| GetActionPlan | 查询执行计划详情。 | 查询执行计划详情 |
| DeleteActionPlan | 删除执行计划。 | 删除执行计划 |
镜像
|
API |
标题 |
API概述 |
| AddImage | 添加镜像 | 添加用户自定义镜像。 |
| GetImage | 获取镜像详情 | 获取镜像详情。 |
| GetAppVersions | 获取应用版本列表 | 获取应用版本列表。 |
| ListImages | 查询镜像列表 | 查询镜像列表。 |
| RemoveImage | 移除镜像 | 移除用户自定义镜像 |
| SynchronizeApp | 同步应用 | 应用跨地域同步 |
作业
|
API |
标题 |
API概述 |
| CreateJob | 创建作业 | 创建一个E-HPC Instant 作业。 |
| DeleteJobs | 删除作业 | 删除指定集群中一个或多个作业。 |
| DeleteJobRecords | 删除作业记录 | 删除指定集群中一个或多个处于终态的作业记录。 |
| DescribeJobResults | 查询作业日志 | 查询作业日志 |
| GetJob | 获取作业详情 | 获取执行作业详情。 |
| GetJobRecordDuration | 获取作业记录保留时长 | 获取作业保留时长。 |
| ListJobs | 查询作业列表 | 查询作业列表。 |
| ListExecutors | 查询全局Executor信息 | 查询全局Executor信息 |
| ListJobExecutors | 查询作业Executor信息 | 查询作业Executor信息。 |
| ListExecutorEvents | 查询Executor运行事件 | 查询一个或多个Executor的运行事件列表。 |
| UpdateJobRecordDuration | 更新作业保留时长 | 更新作业保留时长。 |
监控
|
API |
标题 |
API概述 |
| DescribeJobMetricData | 查询作业监控项的监控数据 | 通过指定特定作业数组索引及查询监控项参数，查询作业的监控时序数据集。 |
| DescribeJobMetricLast | 查询作业监控项的即时监控数据 | 通过指定特定的作业数组索引列表，查询作业数组列表下的所有即时监控指标。 |
资源池
|
API |
标题 |
API概述 |
| CreatePool | 创建资源池 | 创建资源池。 |
| DeletePool | 删除资源池 | 删除资源池。 |
| GetPool | 获取资源池详情 | 获取资源池详情。 |
| ListPools | 查询资源池列表 | 查询资源池列表。 |
| UpdatePool | 更新资源池配置 | 更新资源池配置。 |
其他
|
API |
标题 |
API概述 |
| ListTagResources | 查询已经绑定的标签列表 | 查询一个或多个Instant资源已经绑定的标签列表 |
| TagResources | 创建并绑定标签 | 为Instant资源列表统一创建并绑定标签 |
| UnTagResources | 统一解绑标签 | 为Instant资源列表统一解绑标签。解绑后，如果该标签没有绑定其他任何资源，会被自动删除。 |
该文章对您有帮助吗？