API概览

MRS提供的符合RESTful API的设计规范的接口，如表1和表2所示。如何选择不同版本的接口请参见API版本选择建议。

MRS版本演进过程中逐步废弃部分接口，具体请参见表3。

表1 V2接口
接口	功能	API URI
集群管理接口	创建集群-CreateCluster	POST /v2/{project_id}/clusters
	修改集群名称-UpdateClusterName	PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name
	创建集群并提交作业-CreateClusterAndSubmitJob	POST /v2/{project_id}/run-job-flow
	获取当前集群通信安全授权状态-ListSecurityRuleStatus	GET /v2/{project_id}/clusters/{cluster_id}/security-rule/status
	扩容集群-ExpandCluster	POST /v2/{project_id}/clusters/{cluster_id}/expand
	缩容集群-ShrinkCluster	POST /v2/{project_id}/clusters/{cluster_id}/shrink
	集群添加组件-AddComponent	POST /v2/{project_id}/clusters/{cluster_id}/components
	查询集群节点列表-ListNodes	GET /v2/{project_id}/clusters/{cluster_id}/nodes
作业对象接口	新增并执行作业-CreateExecuteJob	POST /v2/{project_id}/clusters/{cluster_id}/job-executions
	查询作业列表信息-ShowJobList	GET /v2/{project_id}/clusters/{cluster_id}/job-executions
	查询单个作业信息-ShowSingleJob	GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}
	终止作业-StopJob	POST /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill
	获取SQL结果-ShowSqlResultWithJob	GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/sql-result
	批量删除作业-BatchDeleteJobs	POST /v2/{project_id}/clusters/{cluster_id}/job-executions/batch-delete
弹性伸缩接口	查看弹性伸缩策略-ShowAutoScalingPolicy	GET /v2/{project_id}/autoscaling-policy/{cluster_id}
	更新弹性伸缩策略-UpdateAutoScalingPolicy	PUT /v2/{project_id}/autoscaling-policy/{cluster_id}
	删除弹性伸缩策略-DeleteAutoScalingPolicy	DELETE /v2/{project_id}/autoscaling-policy/{cluster_id}
	创建弹性伸缩策略-CreateAutoScalingPolicy	POST /v2/{project_id}/autoscaling-policy/{cluster_id}
集群HDFS文件接口	获取指定目录文件列表-ShowHdfsFileList	GET /v2/{project_id}/clusters/{cluster_id}/files?path={directory}&offset={offset}&limit={limit}&sort_key={sort_key}&order={order}
SQL接口	提交SQL语句-ExecuteSql	POST /v2/{project_id}/clusters/{cluster_id}/sql-execution
	查询SQL结果-ShowSqlResult	GET /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}
	取消SQL执行任务-CancelSql	POST /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel
委托管理（V2）	查询用户（组）与IAM委托的映射关系-ShowAgencyMapping	GET /v2/{project_id}/clusters/{cluster_id}/agency-mapping
委托管理（V2）	更新用户（组）与IAM委托的映射关系-UpdateAgencyMapping	PUT /v2/{project_id}/clusters/{cluster_id}/agency-mapping
数据连接管理	创建数据连接-CreateDataConnector	POST /v2/{project_id}/data-connectors
	查询数据连接列表-ListDataConnector	GET /v2/{project_id}/data-connectors
	更新数据连接-UpdateDataConnector	PUT /v2/{project_id}/data-connectors/{connector_id}
	删除数据连接-DeleteDataConnector	DELETE /v2/{project_id}/data-connectors/{connector_id}
版本元数据查询	展示MRS版本列表-ShowMrsVersionList	GET /v2/{project_id}/metadata/versions
版本元数据查询	查询MRS集群版本可用的规格-ShowMrsFlavors	GET /v2/{project_id}/metadata/version/{version_name}/available-flavor
IAM同步管理接口	查询当前集群是否在IAM同步进行中-ListClusterSyncTaskStatus	GET /v2/{project_id}/clusters/{cluster_id}/iam-sync
	查询指定集群的IAM同步情况-ListClusterSyncStatus	GET /v2/{project_id}/clusters/{cluster_id}/iam-sync/is-synchronous
	获取已经同步的IAM用户和用户组-ShowSyncIamUser	GET /v2/{project_id}/clusters/{cluster_id}/iam-sync-user
	IAM同步-UpdateSyncIamUser	POST /v2/{project_id}/clusters/{cluster_id}/iam-sync-user
	指定用户、用户组取消同步-CancelSyncIamUser	DELETE /v2/{project_id}/clusters/{cluster_id}/iam-sync-user
标签管理接口	集群操作默认标签-SwitchClusterTags	POST /v2/{project_id}/clusters/{cluster_id}/tags/switch
	查询默认标签状态-ShowDefaultTagStatus	GET /v2/{project_id}/clusters/{cluster_id}/tags/status
	查询标签配额-ShowTagQuota	GET /v2/{project_id}/clusters/{cluster_id}/tags/quota

表2 V1.1接口
接口	功能	API URI
集群管理接口	创建集群并执行作业-CreateClusterAndSubmitJob	POST /v1.1/{project_id}/run-job-flow
	调整集群节点-ModifyClusterNode	PUT /v1.1/{project_id}/cluster_infos/{cluster_id}
	查询集群列表-ListClusters	GET /v1.1/{project_id}/cluster_infos
	查询集群详情-ShowClusterDetails	GET /v1.1/{project_id}/cluster_infos/{cluster_id}
	查询主机列表-ListHosts	GET /v1.1/{project_id}/clusters/{cluster_id}/hosts
	删除集群-DeleteCluster	DELETE /v1.1/{project_id}/clusters/{cluster_id}
弹性伸缩接口	配置弹性伸缩规则-CreateAutoScalingPolicy	POST /v1.1/{project_id}/autoscaling-policy/{cluster_id}
标签管理接口	给指定集群添加标签-CreateClusterTag	POST /v1.1/{project_id}/clusters/{cluster_id}/tags
	查询指定集群的标签-ListClusterTags	GET /v1.1/{project_id}/clusters/{cluster_id}/tags
	删除指定集群的标签-DeleteClusterTag	DELETE /v1.1/{project_id}/clusters/{cluster_id}/tags/{key}
	批量添加集群标签-BatchCreateClusterTags	POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action
	批量删除集群标签-BatchDeleteClusterTags	POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action
	查询所有标签-ListAllTags	GET /v1.1/{project_id}/clusters/tags
	查询特定标签的集群列表-ListClustersByTags	POST /v1.1/{project_id}/clusters/resource_instances/action
可用区	查询可用区信息-ListAvailableZones	GET /v1.1/{region_id}/available-zones
版本元数据查询	查询对应版本元数据-ShowMrsVersionMetadata	GET /v1.1/{project_id}/metadata/versions/{version_name}

表3 历史API接口
接口	功能	API URI
V1.1 作业管理接口	新增作业并执行	POST /v1.1/{project_id}/jobs/submit-job
	查询作业exe对象列表	GET /v1.1/{project_id}/job-exes
	查询作业exe对象详情	GET /v1.1/{project_id}/job-exes/{job_exe_id}
	删除作业执行对象	DELETE /v1.1/{project_id}/job-executions/{job_execution_id}

上一篇：使用前必读

下一篇：API版本选择建议

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

API概览

相关文档

意见反馈

文档内容是否对您有帮助？