API概览
弹性高性能计算E-HPC的OpenAPI采用RFC签名风格，请求结构和签名细节请参见RPC调用机制。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见创建AccessKey。
集群
API | 描述 |
调用DescribePrice查询集群价格配置信息。 | |
调用ListPreferredEcsTypes查询E-HPC推荐的ECS实例规格。 | |
调用ListAvailableEcsTypes查询可用的ECS实例规格资源。 | |
调用CreateCluster创建一个按量付费或者包年包月的集群。 | |
调用GetIfEcsTypeSupportHtConfig查询指定的实例规格是否支持开启和关闭超线程。 | |
调用ModifyClusterAttributes修改指定集群的基本信息，包括修改集群名称、集群描述和集群镜像。 | |
调用ListClusters查询账号中所有地域拥有的集群列表。 | |
调用ListClustersMeta查询集群元数据列表。 | |
调用DescribeCluster查询指定集群信息。 | |
调用ListClusterLogs查询集群三天内的操作记录。 | |
调用StartCluster启动指定集群。 | |
调用RecoverCluster重置并修复指定集群。 | |
调用StopCluster停止指定集群。 | |
调用DeleteCluster释放指定集群。 | |
调用ListTasks查询指定集群下异步API的返回结果。 |
混合云集群
API | 描述 |
调用CreateHybridCluster创建一个混合云集群。 | |
调用AddLocalNodes将本地计算节点加到混合云集群或者云上集群。 | |
调用GetHybridClusterConfig获取混合云集群配置。 |
节点
API | 描述 |
调用AddNodes增加一个或多个计算节点。 | |
调用AddExistedNodes添加一个或多个已创建的ECS实例作为计算节点，加入到指定集群中。 | |
调用ApplyNodes添加一个或多个按量计费（含抢占式）计算节点到指定集群中。 | |
调用ListNodes查询指定集群中的节点列表。 | |
调用ListNodesNoPaging不分页查询指定集群中的节点列表。 | |
调用StartNodes启动集群中的一个或多个节点。 | |
调用ResetNodes重置一个或多个计算节点。 | |
调用StopNodes停止集群中的一个或多个节点。 | |
调用DeleteNodes删除一个或多个计算节点。 |
队列
API | 描述 |
调用AddQueue为指定集群新建一个队列。 | |
调用ListQueues查询指定集群队列列表。 | |
调用UpdateQueueConfig更新集群队列中的资源组和计算节点实例信息。 | |
调用SetQueue移动计算节点到指定队列。 | |
调用ListNodesByQueue查询集群指定队列中的节点信息。 | |
调用DeleteQueue删除一个集群中的队列。 |
调度器
API | 描述 |
调用SetSchedulerInfo为指定集群设置调度器配置信息。 | |
调用GetSchedulerInfo查询指定集群的调度信息。 |
自动伸缩
API | 描述 |
调用SetAutoScaleConfig设置指定集群的自动伸缩配置信息。 | |
调用DescribeAutoScaleConfig查询指定集群的自动伸缩配置信息。 | |
调用GetAutoScaleConfig获取指定集群的自动伸缩配置信息。 |
用户
API | 描述 |
调用AddUsers批量增加用户。 | |
调用ListUsers查询集群中的用户列表。 | |
调用ModifyUserPasswords批量修改用户密码。 | |
调用ModifyUserGroups批量修改用户权限。 | |
调用DeleteUsers批量删除集群用户。 | |
调用SyncUsers在混合云代理模式下，同步本地集群用户到线上混合云集群中。 |
存储
API | 描述 |
调用GetClusterVolumes查询指定集群中的存储卷信息。 | |
调用ListFileSystemWithMountTargets查询文件系统和挂载点。 | |
调用UpdateClusterVolumes为指定集群更新挂载存储资源。 | |
调用ListVolumes查询文件系统列表。 |
作业
API | 描述 |
调用CreateJobFile创建一个作业文件。 | |
调用SubmitJob提交作业。 | |
调用RerunJobs重新运行作业。 | |
调用DescribeJob查询作业信息。 | |
调用ListJobs查询作业列表。 | |
调用ListJobsWithFilters按照相关参数查询指定作业详情。 | |
调用StopJobs批量停止作业。 | |
调用DeleteJobs批量删除作业。 |
作业模板
API | 描述 |
调用CreateJobTemplate创建作业模板。 | |
调用EditJobTemplate编辑作业模板。 | |
调用ListJobTemplates查询作业模板列表。 | |
调用DeleteJobTemplates批量删除作业模板。 |
交互命令
API | 描述 |
调用InvokeShellCommand在指定的集群节点内执行交互命令。 | |
调用ListCommands查看指定集群内的交互命令列表。 | |
调用ListInvocationStatus查看执行的交互命令运行的状态。 | |
调用ListInvocationResults查看指定集群内交互命令的运行结果。 |
后处理脚本
API | 描述 |
调用SetPostScripts设置集群后处理脚本。 | |
调用GetPostScripts查询指定集群的后处理脚本。 |
资源报表和服务关联角色
API | 描述 |
调用GetAccountingReport获取资源报表信息。 | |
调用InitializeEHPC创建E-HPC服务的关联角色。 |
软件
API | 描述 |
调用ListSoftwares查询E-HPC支持安装的软件列表。 | |
调用UninstallSoftware卸载集群上已安装的软件。 | |
调用ListInstalledSoftware查询指定集群下已安装的软件列表。 | |
调用InstallSoftware为集群安装软件。 |
镜像
API | 描述 |
调用DescribeEstackImage查询E-HPC基础镜像。 | |
调用ListImages查询E-HPC支持的镜像列表。 | |
调用ListCustomImages查询E-HPC支持的自定义镜像和共享镜像列表。 | |
调用ListCommunityImages查询社区镜像。 | |
调用SummaryImages获取指定集群上的全部镜像名称，便于您管理集群上的镜像。 | |
调用SummaryImagesInfo获取指定集群上已有镜像的详细信息，包括镜像获取日期，镜像大小等内容。 | |
调用GetUserImage将您保存在OSS中的自有镜像，拉取到指定集群中，并按E-HPC标准镜像管理方式进行管理。 | |
调用DeleteLocalImage删除已下载到集群的镜像。 |
容器应用
API | 描述 |
调用AddContainerApp新增容器应用 | |
调用ModifyContainerAppAttributes修改一个容器应用的部分属性，目前支持修改容器应用的描述。 | |
调用ListContainerApps查询容器应用列表及详细信息。 | |
调用DescribeContainerApp查询指定容器应用信息。 | |
调用DeleteContainerApps批量删除容器应用信息。 | |
调用PullImage来拉取镜像。 | |
调用InspectImage展示镜像构建信息，即容器镜像inspect信息。 | |
调用ListContainerImages查询指定集群的本地镜像列表。 | |
调用DescribeImage查询指定集群本地镜像信息。 | |
调用DeleteImage删除本地镜像。 |
E-HPC优化器
API | 描述 |
调用RunCloudMetricProfiling启动指定集群的性能剖析。 | |
调用GetCloudMetricLogs获取E-HPC性能指标日志。 | |
调用GetCloudMetricProfiling获取集群任务性能剖析结果。 | |
调用ListCloudMetricProfilings查询指定集群的历史性能剖析信息。 |
服务包
API | 描述 |
调用QueryServicePackAndPrice查询您购买的E-HPC服务包和当前后付费价格。 |
客户端
API | 描述 |
调用ListCurrentClientVersion查询E-HPC客户端最新版本号。 | |
调用UpgradeClient升级集群客户端到目标版本。 | |
调用ListUpgradeClients查询当前集群可升级的客户端最新版本和历史升级操作。 |
安全组
API | 描述 |
调用AddSecurityGroup将集群加入到指定的安全组。 | |
调用ListSecurityGroups查询指定集群绑定的安全组列表。 | |
调用DeleteSecurityGroup为集群删除指定的安全组。 |
VNC远程可视化
API | 描述 |
调用StartVisualService启动VNC远程服务。 | |
调用ModifyVisualServicePasswd设置VNC服务远程连接密码。 | |
调用GetVisualServiceStatus查询指定集群中VNC远程可视化服务的使用状态。 | |
调用StopVisualService停止VNC远程服务。 |
标签
API | 描述 |
调用TagResources为指定资源创建并绑定标签。 | |
调用ListTagResources查询资源绑定的标签信息。 | |
调用UnTagResources为指定的资源解绑标签。 |
其他
API | 描述 |
调用ListRegions查询可以使用E-HPC的地域列表。 |