API概览

本产品(云原生大数据计算服务 MaxCompute/2022-01-04)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

Quota管理

API标题API概述
ListQuotas获取Quota列表获取Quota列表。
QueryQuota获取指定一级Quota组信息获取指定一级Quota组信息。
GetQuota获取指定一级Quota组信息获取指定一级Quota组信息。 注意warning: 该接口会在2024年7月31日下线,我们会提供QueryQuota的接口替代,入参,出参,功能完全一样。
ListQuotasPlans获取Quota计划列表获取Quota计划列表。
CreateQuotaPlan创建Quota计划新增Quota计划。
UpdateQuotaPlan更新Quota计划更新Quota计划。
GetQuotaPlan获取Quota计划信息获取Quota计划信息。
DeleteQuotaPlan删除Quota计划删除Quota计划。
UpdateQuotaSchedule更新Quota时间计划更新Quota时间计划信息。
GetQuotaSchedule获取Quota时间计划信息获取Quota时间计划信息。
Tunnel Quota分时配置Tunnel Quota分时配置
ListTunnelQuotaTimer查看Quota(Tunnel)分时扩缩容配置查看数据传输服务独享资源组(Tunnel Quota)的分时扩缩容配置。
UpdateTunnelQuotaTimer更新Quota(Tunnel)分时扩缩容配置更新数据传输服务独享资源组(Tunnel Quota)的分时扩缩容配置。

项目管理

API标题API概述
基础管理(Project)基础管理(Project)
CreateProject创建项目创建MaxCompute项目。
ListProjects获取项目列表获取MaxCompute项目列表。
GetProject获取项目信息查询MaxCompute项目的基本信息。
UpdateProjectBasicMeta修改项目基本信息修改项目基本信息
UpdateProjectDefaultQuota修改项目默认计算Quota修改项目默认计算Quota
UpdateProjectIpWhiteList修改项目IP白名单修改MaxCompute项目IP白名单。
GetTrustedProjects获取受信任项目列表获取当前项目的TrustedProject(受信任项目)列表。
角色权限(Role、User)角色权限(Role、User)
ListProjectUsers获取项目用户列表获取项目用户列表。
CreateRole创建项目级角色创建MaxCompute项目级角色。
ListRoles获取项目级角色列表获取MaxCompute项目级角色列表。
GetRoleAcl获取项目级角色ACL授权信息获取项目级角色ACL授权信息。
GetRoleAclOnObject获取角色对某对象的ACL授权获取项目级角色对某对象的ACL授权信息。
GetRolePolicy获取角色Policy授权内容获取项目级角色Policy授权内容。
ListUsersByRole获取绑定某项目级角色的用户列表获取绑定某项目级角色的用户列表。
PackagePackage
ListPackages获取Package列表获取MaxCompute项目下的Package列表。
UpdatePackage更新Package更新Package内的对象及允许安装的项目列表。
CreatePackage创建package通过调用该接口创建package。
GetPackage获取Package信息获取package信息。
表(Table)表(Table)
ListTables获取表列表获取MaxCompute项目内的表列表。
GetTableInfo获取表信息查看MaxCompute内部表、视图、外部表、聚簇表或Transactional表的信息。
函数(Function)函数(Function)
ListFunctions获取函数列表获取MaxCompute函数列表。
资源(Resource)资源(Resource)
ListResources获取资源列表获取MaxCompute项目内的资源列表。

租户管理

API标题API概述
ListUsers获取用户列表获取租户下的所有用户列表。

资源观测

API标题API概述
GetQuotaUsage获取Quota资源消耗信息获取Quota资源消耗信息
ListStorageTablesInfo获取表存储明细获取某个MaxCompute项目内的表存储明细。
ListStoragePartitionsInfo获取分区存储明细获取某个MaxCompute项目内分区表的各分区存储明细。

作业运维

API标题API概述
ListJobInfos查看作业列表查看作业列表
GetRunningJobs获取运行态的作业列表指定时间范围内,所有仍处于“运行中”的作业的运行态数据展示。
KillJobs终止作业终止正在运行的作业。
GetJobResourceUsage获得作业执行者级别的资源使用列表指定时间范围内,针对已结束的全部作业进行统计,以“天”为级别展示作业执行者级别的资源使用总量。

数据迁移

API标题API概述
CreateMmsDataSource创建数据源创建数据源,通过MMA将数据源的数据迁移到MaxCompute。
GetMmsDataSource获取单个数据源详情获取单个MMA数据源详情
ListMmsDataSources列出数据源列出MMA数据源
UpdateMmsDataSource更新数据源配置、启/停数据源实例重新拉取MMA数据源的元数据
DeleteMmsDataSource删除数据源删除MMA数据源,包括数据源的迁移计划、元数据
CreateMmsFetchMetadataJob创建“同步数据源元数据”任务“拉取数据源元数据”任务会将数据源的元数据拉取出来
GetMmsFetchMetadataJob获取“同步元数据”任务详情获取单个MMA“获取元数据”任务详情
ListMmsDbs获取数据源内的"数据库"列表列出MMA数据源内的库
GetMmsDb获取数据源内的某个库获取MMA数据源内的某个库
ListMmsTables列出数据源内的表列出MMA数据源内的表
GetMmsTable获取MMA数据源内的某张表获取MMA数据源内的某张表
ListMmsPartitions列出数据源内的分区列出MMA数据源内的分区
GetMmsPartition获取数据源内的某个分区获取MMA数据源内的某个分区
CreateMmsJob创建数据迁移任务创建数据迁移任务
ListMmsJobs获取迁移作业列表获取迁移作业列表
GetMmsJob获取单个迁移作业详情 获取单个MMA迁移计划详情
GetMmsAsyncTask获取数据迁移相关的单个异步任务详情获取MMA单个异步任务
DeleteMmsJob删除数据迁移作业删除MMA的数据迁移计划