更新时间:2022-12-14 GMT+08:00

API概览

MRS提供的符合RESTful API的设计规范的接口,如表1所示。

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

表1 接口

接口

功能

API URI

集群管理接口(V2)

创建集群

POST /v2/{project_id}/clusters

作业对象接口(V2)

新增并执行作业

POST /v2/{project_id}/clusters/{cluster_id}/job-executions

查询单个作业信息

GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}

查询作业列表信息

GET /v2/{project_id}/clusters/{cluster_id}/job-executions

终止作业

POST /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill

批量删除作业

POST /v2/{project_id}/clusters/{cluster_id}/job-executions/batch-delete

获取SQL结果

GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/sql-result

SQL接口(V2)

提交SQL语句

POST /v2/{project_id}/clusters/{cluster_id}/sql-execution

查询SQL结果

GET /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}

取消SQL执行任务

POST /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel

数据源接口(V1.1)

创建数据源

POST /v1.1/{project_id}/data-sources

更新数据源

PUT /v1.1/{project_id}/data-sources/{data_source_id}

查询数据源列表

GET /v1.1/{project_id}/data-sources

查询数据源详情

GET /v1.1/{project_id}/data-sources/{data_source_id}

删除数据源

DELETE /v1.1/{project_id}/data-sources/{data_source_id}

集群管理接口(V1.1)

创建集群并执行作业

POST /v1.1/{project_id}/run-job-flow

调整集群节点

PUT /v1.1/{project_id}/cluster_infos/{cluster_id}

查询集群列表

GET /v1.1/{project_id}/cluster_infos

查询集群详情

GET /v1.1/{project_id}/cluster_infos/{cluster_id}

删除集群

DELETE /v1.1/{project_id}/clusters/{cluster_id}

查询主机列表

GET /v1.1/{project_id}/clusters/{cluster_id}/hosts

作业二进制对象接口(V1.1)

创建作业二进制对象

POST /v1.1/{project_id}/job-binaries

更新作业二进制对象

PUT /v1.1/{project_id}/job-binaries/{job_binary_id}

查询作业二进制列表

GET /v1.1/{project_id}/job-binaries

查询作业二进制详情

GET /v1.1/{project_id}/job-binaries/{job_binary_id}

删除作业二进制对象

DELETE /v1.1/{project_id}/job-binaries/{job_binary_id}

作业对象接口(V1.1)

新增作业并执行(废弃)

POST /v1.1/{project_id}/jobs/submit-job

创建作业对象

POST /v1.1/{project_id}/jobs

更新作业对象

PATCH /v1.1/{project_id}/jobs/{job_id}

执行作业对象

POST /v1.1/{project_id}/jobs/{job_id}/execute

查询作业对象列表

GET /v1.1/{project_id}/jobs

查询作业对象详情

GET /v1.1/{project_id}/jobs/{job_id}

查询作业exe对象列表(废弃)

GET /v1.1/{project_id}/job-exes

查询作业exe对象详情(废弃)

GET /v1.1/{project_id}/job-exes/{job_exe_id}

删除作业对象

DELETE /v1.1/{project_id}/jobs/{job_id}

作业执行对象接口(V1.1)

查询作业执行对象列表

GET /v1.1/{project_id}/job-executions

查询作业执行对象详情

GET /v1.1/{project_id}/job-executions/{job_execution_id}

取消作业执行

GET /v1.1/{project_id}/job-executions/{job_execution_id}/cancel

删除作业执行对象(废弃)

DELETE /v1.1/{project_id}/job-executions/{job_execution_id}

弹性伸缩接口(V1.1)

配置弹性伸缩规则

POST /v1.1/{project_id}/autoscaling-policy/{cluster_id}

标签管理接口(V1.1)

给指定集群添加标签

POST /v1.1/{project_id}/clusters/{cluster_id}/tags

删除指定集群的标签

DELETE /v1.1/{project_id}/clusters/{cluster_id}/tags/{key}

查询指定集群的标签

GET /v1.1/{project_id}/clusters/{cluster_id}/tags

批量添加/删除集群标签

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

查询所有标签

GET /v1.1/{project_id}/clusters/tags

查询特定标签的集群列表

POST /v1.1/{project_id}/clusters/resource_instances/action

表2 历史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}