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: 该接口会在2024731日下线,我们会提供QueryQuota的接口替代,入参,出参,功能完全一样。
计算Quota配置 计算Quota配置
CreateComputeQuotaPlan 创建计算Quota计划 创建计算Quota计划。
UpdateComputeSubQuota 更新计算Quota基础配置 更新MaxCompute的基础配置,包括增加和删除二级Quota,定义二级Quota的基础属性和当前生效的Quota计划的CU配置。
GetComputeQuotaPlan 获取计算Quota计划详细信息 获取单个计算Quota计划的详细信息。
ListComputeQuotaPlan 列举计算Quota计划 列举计算Quota计划。
UpdateComputeQuotaPlan 更新Quota计划 更新Quota计划。
DeleteComputeQuotaPlan 删除计算Quota计划 删除MaxCompute计算Quota计划。
ApplyComputeQuotaPlan 立即生效Quota计划 立即生效Quota计划。
GetComputeQuotaSchedule 获取计算Quota分时计划 获取计算Quota分时计划。
UpdateComputeQuotaSchedule 更新计算Quota分时计划 更新计算Quota分时计划。
GetComputeEffectivePlan 获取当前生效的计算Quota计划 获取当前生效的计算Quota计划。
Tunnel Quota分时配置 Tunnel Quota分时配置
ListTunnelQuotaTimer 查看Quota(Tunnel)分时扩缩容配置 查看数据传输服务独享资源组(Tunnel Quota)的分时扩缩容配置。
UpdateTunnelQuotaTimer 更新Quota(Tunnel)分时扩缩容配置 更新数据传输服务独享资源组(Tunnel Quota)的分时扩缩容配置。
计算Quota配置(旧版,不推荐使用) 计算Quota配置(旧版,不推荐使用)
CreateQuotaPlan 创建Quota计划 新增Quota计划。
GetQuotaPlan 获取Quota计划信息 获取Quota计划信息。
UpdateQuotaPlan 更新Quota计划 更新Quota计划。
ListQuotasPlans 获取Quota计划列表 获取Quota计划列表。
DeleteQuotaPlan 删除Quota计划 删除Quota计划。
UpdateQuotaSchedule 更新Quota时间计划 更新Quota时间计划信息。
GetQuotaSchedule 获取Quota时间计划信息 获取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 获取绑定某项目级角色的用户列表 获取绑定某项目级角色的用户列表。
UpdateUsersToRole 项目角色添加或删除用户 项目角色添加或删除用户
Package Package
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概述

QueryTunnelMetricDetail Tunnel资源观测详情数据 用于查询指定时间范围内的Tunnel数据传输服务相关详情数据。
QueryTunnelMetric Tunnel资源观测时序数据 用于查询指定时间范围内的Tunnel数据传输服务相关指标数据。
GetQuotaUsage 获取Quota资源消耗信息 获取Quota资源消耗信息
ListJobMetric 获取作业性能指标 获取运行结束的作业的性能指标。
QueryStorageMetric 存储资源观测时序数据 查看存储数据的时序指标
ListStorageTablesInfo 获取表存储明细 获取某个MaxCompute项目内的表存储明细。
ListStoragePartitionsInfo 获取分区存储明细 获取某个MaxCompute项目内分区表的各分区存储明细。
GetStorageSizeSummary 获取存储用量信息 获取存储用量信息。
GetStorageAmountSummary 获取存储总量信息 获取存储总量信息。
GetStorageSummaryCompared 存储趋势同比变化 获取存储趋势同比变化。
ListStorageProjectsInfo 获取项目存储明细 获取项目存储明细。

作业运维

API

标题

API概述

ListJobInfos 查看作业列表 查看作业列表
ListJobSnapshotInfos 获取作业快照列表 获取某个时间点的作业快照数据。
GetJobInfo 查看作业的基础信息 查看单个作业的基础信息。
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的数据迁移计划
StartMmsJob 启动数据迁移作业 开启数据迁移作业
StopMmsJob 停止数据迁移作业 停止数据迁移作业
RetryMmsJob 重试数据迁移作业 重试数据迁移作业
ListMmsTasks 获取数据迁移任务列表 获取迁移任务列表
GetMmsTask 获取单个迁移任务详情 获取单个迁移任务详情
ListMmsTaskLogs 列出单个迁移任务的执行日志 列出单个迁移任务的执行日志

成本分析

API

标题

API概述

ListComputeMetricsByInstance 列出后付费作业计算用量 列出后付费作业计算用量。

其他

API

标题

API概述

SumStorageMetricsByDate 存储用量汇总 指定日期查看各个类别的存储信息或各个project的存储信息。