# API概览 MRS提供的符合RESTful API的设计规范的接口，如[表1]和[表2]所示。如何选择不同版本的接口请参见[API版本选择建议](https://support.huaweicloud.com/api-mrs/mrs_02_0006.html)。 MRS版本演进过程中逐步废弃部分接口，具体请参见[表3]。 表1V2接口 | 类型 | API | 说明 | |:---|:---|:---| | 集群管理接口 | [创建集群-CreateCluster](https://support.huaweicloud.com/api-mrs/mrs_02_0101.html) | 创建MRS集群。 | | 集群管理接口 | [修改集群名称-UpdateClusterName](https://support.huaweicloud.com/api-mrs/UpdateClusterName.html) | 修改集群名称。 | | 集群管理接口 | [创建集群并提交作业-CreateClusterAndSubmitJob](https://support.huaweicloud.com/api-mrs/RunJobFlow.html) | 创建一个MRS集群并提交作业，并支持作业完成后删除集群。 | | 集群管理接口 | [获取当前集群通信安全授权状态-ListSecurityRuleStatus](https://support.huaweicloud.com/api-mrs/ListSecurityRuleStatus.html) | 获取当前集群通信安全授权状态。 | | 集群管理接口 | [开启/关闭集群界面授权-UpdateClusterAuthTros](https://support.huaweicloud.com/api-mrs/UpdateClusterAuthTros.html) | 开启/关闭集群界面授权。 | | 集群管理接口 | [查询集群界面授权状态-ListClusterManagerAuthState](https://support.huaweicloud.com/api-mrs/ListClusterManagerAuthState.html) | 查询集群界面授权状态。 | | 集群管理接口 | [扩容集群-ExpandCluster](https://support.huaweicloud.com/api-mrs/ExpandCluster.html) | 对MRS集群进行扩容。 | | 集群管理接口 | [缩容集群-ShrinkCluster](https://support.huaweicloud.com/api-mrs/ShrinkCluster.html) | 对MRS集群进行缩容。 | | 集群管理接口 | [集群添加组件-AddComponent](https://support.huaweicloud.com/api-mrs/AddComponent.html) | 集群添加组件，仅MRS 3.1.2及之后普通版本和MRS 3.1.2-LTS.2及之后的LTS版本的自定义集群支持添加组件功能。 | | 集群管理接口 | [查询集群节点列表-ListNodes](https://support.huaweicloud.com/api-mrs/ListNodes.html) | 查询集群节点列表。 | | 作业对象接口 | [新增并执行作业-CreateExecuteJob](https://support.huaweicloud.com/api-mrs/CreateExecuteJob.html) | 在MRS集群中新增并提交一个作业。 | | 作业对象接口 | [查询作业列表信息-ShowJobList](https://support.huaweicloud.com/api-mrs/ShowJobExeListNew.html) | 在MRS指定集群中查询作业管理中提交的作业列表信息。 | | 作业对象接口 | [查询单个作业信息-ShowSingleJob](https://support.huaweicloud.com/api-mrs/ShowSingleJobExe.html) | 在MRS集群中查询指定作业的详细信息。 | | 作业对象接口 | [终止作业-StopJob](https://support.huaweicloud.com/api-mrs/StopJob.html) | 在MRS集群中终止指定作业。 | | 作业对象接口 | [获取SQL结果-ShowSqlResultWithJob](https://support.huaweicloud.com/api-mrs/ShowSqlResultWithJob.html) | 在MRS集群中查询SparkSql和SparkScript两种类型作业的SQL语句运行完成后返回的查询结果。 | | 作业对象接口 | [批量删除作业-BatchDeleteJobs](https://support.huaweicloud.com/api-mrs/BatchDeleteJobs.html) | 在MRS集群中批量删除作业。 | | 弹性伸缩接口 | [查看弹性伸缩策略-ShowAutoScalingPolicy](https://support.huaweicloud.com/api-mrs/ShowAutoScalingPolicy.html) | 查看指定集群的所有的弹性伸缩策略信息。 | | 弹性伸缩接口 | [更新弹性伸缩策略-UpdateAutoScalingPolicy](https://support.huaweicloud.com/api-mrs/UpdateAutoScalingPolicy.html) | 更新弹性伸缩策略。 | | 弹性伸缩接口 | [删除弹性伸缩策略-DeleteAutoScalingPolicy](https://support.huaweicloud.com/api-mrs/DeleteAutoScalingPolicy.html) | 删除弹性伸缩策略。 | | 弹性伸缩接口 | [创建弹性伸缩策略-CreateAutoScalingPolicy](https://support.huaweicloud.com/api-mrs/CreateAutoScalingPolicy.html) | 创建弹性伸缩策略。 | | 集群HDFS文件接口 | [获取指定目录文件列表-ShowHdfsFileList](https://support.huaweicloud.com/api-mrs/mrs_02_0096.html) | 在MRS集群中获取指定目录文件列表。 | | SQL接口 | [提交SQL语句-ExecuteSql](https://support.huaweicloud.com/api-mrs/ExecuteSql.html) | 在MRS集群中提交并执行一条SQL语句。 | | SQL接口 | [查询SQL结果-ShowSqlResult](https://support.huaweicloud.com/api-mrs/ShowSqlResult.html) | 在MRS集群中查询一条SQL的执行结果。 | | SQL接口 | [取消SQL执行任务-CancelSql](https://support.huaweicloud.com/api-mrs/CancelSql.html) | 在MRS集群中取消一条SQL的执行任务。 | | 委托管理（V2） | [查询用户（组）与IAM委托的映射关系-ShowAgencyMapping](https://support.huaweicloud.com/api-mrs/ShowAgencyMapping.html) | 获取用户（组）与IAM委托之间的映射关系的详细信息。 | | 委托管理（V2） | [更新用户（组）与IAM委托的映射关系-UpdateAgencyMapping](https://support.huaweicloud.com/api-mrs/UpdateAgencyMapping.html) | 更新用户（组）与IAM委托之间的映射关系。 | | 数据连接管理 | [创建数据连接-CreateDataConnector](https://support.huaweicloud.com/api-mrs/CreateDataConnector.html) | 创建数据连接。 | | 数据连接管理 | [查询数据连接列表-ListDataConnector](https://support.huaweicloud.com/api-mrs/ListDataConnector.html) | 查询数据连接列表。 | | 数据连接管理 | [更新数据连接-UpdateDataConnector](https://support.huaweicloud.com/api-mrs/UpdateDataConnector.html) | 更新数据连接。 | | 数据连接管理 | [删除数据连接-DeleteDataConnector](https://support.huaweicloud.com/api-mrs/DeleteDataConnector.html) | 删除数据连接。 | | 版本元数据查询 | [展示MRS版本列表-ShowMrsVersionList](https://support.huaweicloud.com/api-mrs/ShowMrsVersionList.html) | 展示MRS版本列表。 | | 版本元数据查询 | [查询MRS集群版本可用的规格-ShowMrsFlavors](https://support.huaweicloud.com/api-mrs/ShowMrsFlavors.html) | 查询MRS集群版本可用的规格。 | | IAM同步管理接口 | [查询当前集群是否在IAM同步进行中-ListClusterSyncTaskStatus](https://support.huaweicloud.com/api-mrs/ListSyncStatus.html) | 查询当前集群是否在IAM同步进行中。 | | IAM同步管理接口 | [查询指定集群的IAM同步情况-ListClusterSyncStatus](https://support.huaweicloud.com/api-mrs/ListSyncRequirements.html) | 查询指定集群的IAM同步情况。 | | IAM同步管理接口 | [获取已经同步的IAM用户和用户组-ShowSyncIamUser](https://support.huaweicloud.com/api-mrs/ShowSyncIamUser.html) | 获取已经同步的IAM用户和用户组。 | | IAM同步管理接口 | [IAM同步-UpdateSyncIamUser](https://support.huaweicloud.com/api-mrs/UpdateSyncIamUser.html) | 将IAM用户和用户组同步到Manager，指定用户的情况下，会将该用户关联的IAM用户组也同步到Manager。 | | IAM同步管理接口 | [指定用户、用户组取消同步-CancelSyncIamUser](https://support.huaweicloud.com/api-mrs/CancelSyncIamUser.html) | 指定用户、用户组取消同步。 | | 标签管理接口 | [集群操作默认标签-SwitchClusterTags](https://support.huaweicloud.com/api-mrs/SwitchClusterTags.html) | 对已有集群启用或关闭集群默认标签。开启后，集群内节点会打上集群默认标签。 | | 标签管理接口 | [查询默认标签状态-ShowDefaultTagStatus](https://support.huaweicloud.com/api-mrs/ShowTagStatus.html) | 查询集群默认标签状态。 | | 标签管理接口 | [查询标签配额-ShowTagQuota](https://support.huaweicloud.com/api-mrs/ShowTagQuota.html) | 查询标签配额信息。 | 表2V1.1接口 | 类型 | API | 说明 | |:---|:---|:---| | 集群管理接口 | [创建集群并执行作业-CreateClusterAndSubmitJob](https://support.huaweicloud.com/api-mrs/mrs_02_0028.html) | 创建一个MRS集群，并在集群中提交一个作业。该接口不兼容Sahara。 | | 集群管理接口 | [调整集群节点-ModifyClusterNode](https://support.huaweicloud.com/api-mrs/UpdateClusterScaling.html) | 创建集群后，扩容/缩容集群Core节点或者Task节点。MRS集群创建成功后不支持调整Master节点数量，即不支持扩缩容Master节点。该接口不兼容Sahara。 | | 集群管理接口 | [查询集群列表-ListClusters](https://support.huaweicloud.com/api-mrs/ListClusters.html) | 查看用户创建的集群列表信息。该接口不兼容Sahara。 | | 集群管理接口 | [查询集群详情-ShowClusterDetails](https://support.huaweicloud.com/api-mrs/ShowClusterDetails.html) | 查看指定集群的详细信息。该接口不兼容Sahara。 | | 集群管理接口 | [查询主机列表-ListHosts](https://support.huaweicloud.com/api-mrs/ListHosts.html) | 该接口用于查询输入集群的主机列表详情。 | | 集群管理接口 | [删除集群-DeleteCluster](https://support.huaweicloud.com/api-mrs/DeleteCluster.html) | 数据完成处理分析后或者集群运行异常无法提供服务时可删除集群服务。该接口兼容Sahara。 处于如下状态的集群不允许删除： - scaling-out：扩容中 - scaling-in：缩容中 - starting：启动中 - terminating：删除中 - terminated：已删除 - failed：失败 | | 集群管理接口 | [查询指定集群切换委托任务状态-ListAgencyTaskStatus](https://support.huaweicloud.com/api-mrs/ListAsyncTaskStatus.html) | 查询指定集群切换委托任务状态。 | | 集群管理接口 | [开启/关闭集群节点授权-UpdateClusterSsh](https://support.huaweicloud.com/api-mrs/UpdateClusterSsh.html) | 开启/关闭集群节点授权。 | | 集群管理接口 | [查询集群节点授权状态-ListClusterSshState](https://support.huaweicloud.com/api-mrs/ListClusterSshState.html) | 查询集群节点授权状态。 | | 弹性伸缩接口 | [配置弹性伸缩规则-CreateAutoScalingPolicy](https://support.huaweicloud.com/api-mrs/CreateScalingPolicy.html) | 对弹性伸缩规则进行编辑。 在创建集群并执行作业接口中也可以创建弹性伸缩规则。 | | 可用区 | [查询可用区信息-ListAvailableZones](https://support.huaweicloud.com/api-mrs/ListAvailableZones.html) | 在创建集群时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。 | | 版本元数据查询 | [查询对应版本元数据-ShowMrsVersionMetadata](https://support.huaweicloud.com/api-mrs/ShowMrsVersionMetadata.html) | 查询对应版本元数据。如果参数里指定集群ID，则可查询集群更新过补丁之后的最新元数据。 | | 标签管理接口 | [给指定集群添加标签-CreateClusterTag](https://support.huaweicloud.com/api-mrs/CreateClusterTag.html) | 为特定的集群添加一个tag。 | | 标签管理接口 | [查询指定集群的标签-ListClusterTags](https://support.huaweicloud.com/api-mrs/ListClusterTags.html) | 查询指定集群的标签信息。 | | 标签管理接口 | [删除指定集群的标签-DeleteClusterTag](https://support.huaweicloud.com/api-mrs/DeleteClusterTag.html) | 删除特定集群的标签。 | | 标签管理接口 | [批量添加集群标签-BatchCreateClusterTags](https://support.huaweicloud.com/api-mrs/BatchCreateClusterTags.html) | 为指定集群批量添加标签。 | | 标签管理接口 | [批量删除集群标签-BatchDeleteClusterTags](https://support.huaweicloud.com/api-mrs/BatchDeleteClusterTags.html) | 为指定集群批量删除标签。 | | 标签管理接口 | [查询所有标签-ListAllTags](https://support.huaweicloud.com/api-mrs/ListAllTags.html) | 查询租户在指定Region下的所有标签集合。 | | 标签管理接口 | [查询特定标签的集群列表-ListClustersByTags](https://support.huaweicloud.com/api-mrs/ListClustersByTags.html) | 使用标签过滤集群。 | 表3历史API接口 | 类型 | API | 说明 | |:---|:---|:---| | V1.1 作业管理接口 | [新增作业并执行](https://support.huaweicloud.com/api-mrs/CreateAndExecuteJob.html) | 在MRS集群中新增一个作业，并执行作业。该接口不兼容Sahara。 | | V1.1 作业管理接口 | [查询作业exe对象列表](https://support.huaweicloud.com/api-mrs/ListExecuteJob.html) | 查询所有作业的exe对象列表。该接口不兼容Sahara。 | | V1.1 作业管理接口 | [查询作业exe对象详情](https://support.huaweicloud.com/api-mrs/ShowJobExes.html) | 查询指定作业的exe对象详细信息。该接口不兼容Sahara。 | | V1.1 作业管理接口 | [删除作业执行对象](https://support.huaweicloud.com/api-mrs/DeleteJobExecution.html) | 删除指定的作业执行对象。该接口兼容Sahara。 |