API概览

更新时间:
复制为 MD 格式

本产品(EHPC/2024-07-30)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

集群

API

标题

API概述

CreateCluster 创建集群 创建一个按量付费或者预付费(包年包月)集群。
UpdateCluster 修改集群信息 修改指定集群的配置信息。
InstallSoftwares 安装软件 为指定集群安装软件。
UninstallSoftwares 卸载软件 卸载E-HPC集群中已安装的指定软件。
InstallAddon 安装组件 安装自定义服务组件。
UnInstallAddon 卸载组件 卸载自定义服务组件。
AttachSharedStorages 挂载共享存储 E-HPC集群挂载共享存储。
DetachSharedStorages 卸载共享存储 卸载指定集群的挂载目录的共享存储资源。
ListSoftwares 查询支持安装软件列表 查询E-HPC支持安装的软件列表。
ListSharedStorages 查询共享存储列表 查询指定集群下已挂载的共享存储信息。
ListInstalledSoftwares 查询集群已安装软件 查询集群已安装软件。
ListClusters 查询集群列表 查询用户账号中在每个地域拥有的所有集群的列表。
ListAvailableImages 查询可用镜像列表 获取E-HPC集群可用镜像列表。
ListAvailableFileSystems 查询挂载的文件系统列表 查询指定地域可挂载的文件系统列表。
ListAddons 查询已安装组件列表 查看已安装的自定义服务组件列表。
ListAddonTemplates 查询组件模板列表 查询支持的自定义服务组件模板列表。
GetCluster 查询集群详情 查询指定E-HPC集群信息。
GetAddon 查询已安装组件详情 查询已安装的自定义服务组件详情。
DescribeAddonTemplate 查询组件模板详情 查询自定义服务组件模板详情。
DeleteCluster 释放集群 释放指定的E-HPC集群。

用户

API

标题

API概述

CreateUsers 创建集群用户 为指定集群新增一个或多个用户。
UpdateUser 更新集群用户 更新指定集群用户的信息,包括用户组、密码等属性。
ListUsers 查询集群用户列表 查询指定集群的用户列表信息。
DeleteUsers 删除集群用户 删除指定集群的一个或多个用户。

节点与队列

API

标题

API概述

CreateQueue 创建队列 为指定的E-HPC集群创建队列。
CreateNodes 批量创建计算节点 批量给E-HPC集群创建计算节点。
UpdateQueue 修改队列配置 修改E-HPC集群指定队列的配置信息。
UpdateNodes 批量更新计算节点信息 批量更新E-HPC集群计算节点配置。
ListQueues 查询队列列表 查询指定E-HPC集群的队列列表。
ListNodes 查询计算节点列表 查询E-HPC集群的节点列表。
GetQueue 查询队列详情 查询E-HPC集群指定队列的详情。
DeleteQueues 删除队列 删除E-HPC集群中指定队列。
DeleteNodes 批量删除计算节点 批量删除E-HPC集群的计算节点。

作业

API

标题

API概述

CreateJob 创建作业 为指定集群创建一个作业。
ListJobs 查询作业列表 查询指定集群中的作业列表。
GetJobLog 查询作业输出日志 查询作业运行后的输出日志,包括标准输出日志和错误输出日志。
GetJob 查询作业详情 获取指定作业的详细信息。
StopJobs 批量停止作业 批量停止E-HPC集群中处于“未完成”状态的作业。

监控与日志

API

标题

API概述

ListCommonLogs 查询集群日志列表 查询指定集群某一段时间内的日志列表。
GetCommonLogDetail 查询集群详细日志信息 根据具体操作的请求ID查询日志,通过将操作日志拆分成 Action-Stage-Method 三层日志结构,能够详细罗列出各操作涉及到的详细步骤日志。

其他

API

标题

API概述

AttachNodes 添加游离节点 将不属于E-HPCECS添加到E-HPC集群,作为E-HPC集群计算节点进行管理和操作。
CreateReservedNodePool 创建预设节点池 创建预设节点池。预设节点池会预占用VSwitch下的批量可用IP,一一映射到根据规则生成的主机名上,并维护该映射表对应的节点池资源。当后续使用预设节点池来扩容/缩容节点时,会实际占用/释放对应预设节点池的资源。
DeleteReservedNodePool 删除预设节点池 删除指定的预设节点池。
ListRegions 查询可以使用E-HPC的地域列表 查询产品支持的地域列表。