API概览
MRS提供的符合RESTful API的设计规范的接口，如表1和表2所示。如何选择不同版本的接口请参见API版本选择建议。
MRS版本演进过程中逐步废弃部分接口，具体请参见表3。
| 类型 | API | 说明 |
|---|---|---|
| 集群管理接口 | 创建MRS集群。 | |
| 修改集群名称。 | ||
| 创建一个MRS集群并提交作业，并支持作业完成后删除集群。 | ||
| 获取当前集群通信安全授权状态。 | ||
| 开启/关闭集群界面授权。 | ||
| 查询集群界面授权状态。 | ||
| 对MRS集群进行扩容。 | ||
| 对MRS集群进行缩容。 | ||
| 集群添加组件，仅MRS 3.1.2及之后普通版本和MRS 3.1.2-LTS.2及之后的LTS版本的自定义集群支持添加组件功能。 | ||
| 查询集群节点列表。 | ||
| 作业对象接口 | 在MRS集群中新增并提交一个作业。 | |
| 在MRS指定集群中查询作业管理中提交的作业列表信息。 | ||
| 在MRS集群中查询指定作业的详细信息。 | ||
| 在MRS集群中终止指定作业。 | ||
| 在MRS集群中查询SparkSql和SparkScript两种类型作业的SQL语句运行完成后返回的查询结果。 | ||
| 在MRS集群中批量删除作业。 | ||
| 弹性伸缩接口 | 查看指定集群的所有的弹性伸缩策略信息。 | |
| 更新弹性伸缩策略。 | ||
| 删除弹性伸缩策略。 | ||
| 创建弹性伸缩策略。 | ||
| 集群HDFS文件接口 | 在MRS集群中获取指定目录文件列表。 | |
| SQL接口 | 在MRS集群中提交并执行一条SQL语句。 | |
| 在MRS集群中查询一条SQL的执行结果。 | ||
| 在MRS集群中取消一条SQL的执行任务。 | ||
| 委托管理（V2） | 获取用户（组）与IAM委托之间的映射关系的详细信息。 | |
| 更新用户（组）与IAM委托之间的映射关系。 | ||
| 数据连接管理 | 创建数据连接。 | |
| 查询数据连接列表。 | ||
| 更新数据连接。 | ||
| 删除数据连接。 | ||
| 版本元数据查询 | 展示MRS版本列表。 | |
| 查询MRS集群版本可用的规格。 | ||
| IAM同步管理接口 | 查询当前集群是否在IAM同步进行中。 | |
| 查询指定集群的IAM同步情况。 | ||
| 获取已经同步的IAM用户和用户组。 | ||
| 将IAM用户和用户组同步到Manager，指定用户的情况下，会将该用户关联的IAM用户组也同步到Manager。 | ||
| 指定用户、用户组取消同步。 | ||
| 标签管理接口 | 对已有集群启用或关闭集群默认标签。开启后，集群内节点会打上集群默认标签。 | |
| 查询集群默认标签状态。 | ||
| 查询标签配额信息。 |
| 类型 | API | 说明 |
|---|---|---|
| 集群管理接口 | 创建一个MRS集群，并在集群中提交一个作业。该接口不兼容Sahara。 | |
| 创建集群后，扩容/缩容集群Core节点或者Task节点。MRS集群创建成功后不支持调整Master节点数量，即不支持扩缩容Master节点。该接口不兼容Sahara。 | ||
| 查看用户创建的集群列表信息。该接口不兼容Sahara。 | ||
| 查看指定集群的详细信息。该接口不兼容Sahara。 | ||
| 该接口用于查询输入集群的主机列表详情。 | ||
| 数据完成处理分析后或者集群运行异常无法提供服务时可删除集群服务。该接口兼容Sahara。 处于如下状态的集群不允许删除：
| ||
| 查询指定集群切换委托任务状态。 | ||
| 开启/关闭集群节点授权。 | ||
| 查询集群节点授权状态。 | ||
| 弹性伸缩接口 | 对弹性伸缩规则进行编辑。 在创建集群并执行作业接口中也可以创建弹性伸缩规则。 | |
| 可用区 | 在创建集群时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。 | |
| 版本元数据查询 | 查询对应版本元数据。如果参数里指定集群ID，则可查询集群更新过补丁之后的最新元数据。 | |
| 标签管理接口 | 为特定的集群添加一个tag。 | |
| 查询指定集群的标签信息。 | ||
| 删除特定集群的标签。 | ||
| 为指定集群批量添加标签。 | ||
| 为指定集群批量删除标签。 | ||
| 查询租户在指定Region下的所有标签集合。 | ||
| 使用标签过滤集群。 |
