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