全部产品
云市场

API 概览

更新时间:2020-03-06 13:57:49

您可以通过本文档介绍的API对HPC服务进行相关操作。目前,这里所有的API都以OpenAPI spec进行发布。

说明:请确保在使用这些接口前,已充分了解了E-HPC的产品说明、使用协议和收费方式。

术语

术语 中文 说明
Instance 高性能计算实例,简称实例 一台高性能物理服务器。
Region 地域 代表资源所在的地域,不同地域之间内网不互通。
Package 套餐 某种套餐表示一组有差异的CPU、内存、GPU卡等实例规格的组合,以套餐名称区分。

资源规格说明

注意:接口说明部分,凡出现参数可选值、可用规格方面与官网售卖页上给出的资源规格不一致时,均以售卖页上给出的值为准。

OpenAPI 概览

总计

本期包含89个API。

服务地址

ehpc.aliyuncs.com

API版本

2018-04-12

集群相关接口

API 描述
CreateCluster 新建集群。
DeleteCluster 释放集群。
StartCluster 启动集群。
StopCluster 停止集群。
RecoverCluster 重置并修复集群。
ModifyClusterAttributes 修改集群属性。
ListClusters 查询集群列表。
DescribeCluster 查询集群详细信息。
ListClusterLogs 查询集群操作记录。
ListQueue 查询集群队列列表。
ListClusterMeta 查询集群元列表。

节点相关接口

API 描述
AddNodes 批量新增计算节点(扩容)。
ListNodes 查询节点列表。
ResetNodes 批量重置计算节点。
DeleteNodes 批量移除计算节点。
StartNodes 启动节点列表。
StopNodes 停止节点列表。
ListNodesByQueue 按队列查询节点信息。
UpdateQueueConfig 更新队列配置信息。
ListNodesNoPaging 不分页查询节点列表。

交互执行命令相关接口

API 描述
InvokeShellCommand 执行交互执行命令。
ListCommands 查看交互执行命令信息列表。
ListInvocationStatus 查看交互执行命令状态。
ListInvocationResults 查看交互执行命令结果。

自动伸缩相关接口

API 描述
GetAutoScaleConfig 获取自动伸缩配置信息。
SetAutoScaleConfig 设置自动伸缩配置信息。

容器应用相关接口

API 描述
AddContainerApp 新增容器应用。
DeleteImage 删除本地镜像。
DeleteContainerApps 批量删除容器应用。
DescribeImage 查询本地单个镜像信息。
DescribeContainerApp 查询单个容器应用。
DescribeImageGatewayConfig 查询镜像网关配置文件。
ListContainerApps 查询容器应用列表。
ListContainerImages 查询本地镜像列表。
ModifyImageGatewayConfig 修改镜像网关配置文件。
ModifyContainerAppAttributes 修改容器应用属性。

作业模板相关接口

API 描述
CreateJobTemplate 创建作业模板。
DeleteJobTemplates 删除作业模板。
EditJobTemplate 编辑作业模板。
ListJobTemplates 查询作业模板列表。

作业相关接口

API 描述
CreateJobFile 创建作业文件。
SetJobUser 设置作业owner。
ListJobs 查询作业列表。
SubmitJob 提交作业。
StopJobs 批量停止作业。
DeleteJobs 批量删除作业。

集群用户相关接口

API 描述
ListUsers 查询用户列表。
AddUsers 批量新增用户账号。
DeleteUsers 批量删除用户账号。
ModifyUserGroups 批量修改用户权限组。
ModifyUserPasswords 批量修改用户密码。

共享存储相关接口

API 描述
ListVolumes 查询数据卷列表。
GetClusterVolumes 获取指定集群的共享存储卷。
ListAvailableFileSystemTypes 查询可用文件系统类型。
ListCpfsFileSystems 查询CPFS文件系统。
ListFileSystemWithMountTargets 查询文件系统和挂载点。
UpdateClusterVolumes 更新集群共享存储卷。

报表相关接口

API 描述
GetAccountingReport 读取E-HPC集群资源报表。

软件和镜像相关接口

API 描述
ListRegions 查询可用地域列表。
ListImages 查询支持的系统镜像列表。
ListSoftwares 列出支持的软件列表。
ListCustomImages 查询自定义镜像列表。
ListAvailableEcsTypes 查询云服务器ECS可用的实例规格资源。
ListPreferredEcsTypes 查询推荐的ECS实例规格。
ListInstalledSoftware 查询已安装软件列表。
ListCurrentClientVersion 查询当前E-HPC客户端最新版本号。

E-HPC优化器相关接口

API 描述
GetCloudMetricProfiling 获取性能剖析结果。
ListCloudMetricProfilings 查询历史性能剖析信息。
RunCloudMetricProfiling 启动性能剖析。

可视化服务相关接口

API 描述
CreateGWSCluster 创建可视化服务。
CreateGWSImage 创建图形工作站镜像。
CreateGWSInstance 创建桌面实例。
DeleteGWSCluster 删除可视化服务。
DeleteGWSInstance 删除图形工作站实例。
DescribeGWSClusters 查询图形工作站集群信息。
DescribeGWSImages 查询图形工作站镜像信息。
DescribeGWSInstances 查询桌面实例。
DescribeNFSClientStatus 查询图形工作站实例NFS客户端部署状态。
GetGWSConnectTicket 连接实例桌面/APP。
InstallNFSClient 安装NFS客户端。
SetGWSInstanceUser 指定图形工作站实例用户。
StartGWSInstance 启动图形工作站实例。
StopGWSInstance 停止图形工作站实例。

服务包相关接口

API 描述
QueryServicePackAndPrice 查询用户购买的ehpc服务包和当前后付费价格。
DescribeImagePrice 查询E-HPC支持的镜像市场镜像价格。

客户端相关接口

API 描述
UpgradeClient 升级客户端。

VNC连接相关接口

API 描述
GetVisualServiceStatus 获取VNC可视化服务状态。
ModifyVisualServicePasswd 修改远程可视化VNC服务密码。
StopVisualService 停止可视化服务。

相关文档