API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (MaxCompute/2022-01-04) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Quota Management
|
API |
Title |
Description |
| ListQuotas | ListQuotas | Retrieves a list of quotas. |
| QueryQuota | QueryQuota | Queries the information about a specified level-1 quota group. |
| GetQuota | GetQuota | Retrieve information for the specified level-1 quota group. Warning: This operation will be decommissioned on July 31, 2024. It will be replaced by the `QueryQuota` operation. The request parameters, response parameters, and features of the two operations are the same. |
| Compute Quota | Compute Quota | |
| CreateComputeQuotaPlan | CreateComputeQuotaPlan | Creates a quota plan. |
| UpdateComputeSubQuota | UpdateComputeSubQuota | Updates the basic configuration of a MaxCompute quota. For example, you can call this operation to add or delete a level-2 quota, define the basic attributes of a level-2 quota, and define the configuration of compute units (CUs) for a quota plan that is in effect. |
| GetComputeQuotaPlan | GetComputeQuotaPlan | Get detailed information of a single compute quota plan. |
| ListComputeQuotaPlan | ListComputeQuotaPlan | Get computeQuotaPlan list. |
| UpdateComputeQuotaPlan | UpdateComputeQuotaPlan | Update the ComputeQuotaPlan. |
| DeleteComputeQuotaPlan | DeleteComputeQuotaPlan | Deletes a MaxCompute quota plan. |
| ApplyComputeQuotaPlan | ApplyComputeQuotaPlan | Activate a Quota Plan Immediately. |
| GetComputeQuotaSchedule | GetComputeQuotaSchedule | Displays the time-specific configuration of compute quota. |
| UpdateComputeQuotaSchedule | UpdateComputeQuotaSchedule | Updates the time-based schedule for a computing quota. |
| GetComputeEffectivePlan | GetComputeEffectivePlan | GetComputeEffectivePlan. |
| Tunnel Quota | Tunnel Quota | |
| Compute Quota (old version, not recommended) | Compute Quota (old version, not recommended) | |
| CreateQuotaPlan | CreateQuotaPlan | Creates a quota plan. |
| GetQuotaPlan | GetQuotaPlan | Obtains the information of a quota plan. |
| UpdateQuotaPlan | UpdateQuotaPlan | Updates a quota plan. |
| ListQuotasPlans | ListQuotasPlans | Obtains quota plans. |
| DeleteQuotaPlan | DeleteQuotaPlan | Deletes a quota plan. |
| UpdateQuotaSchedule | UpdateQuotaSchedule | Updates the scheduling plan for a quota plan. |
| GetQuotaSchedule | GetQuotaSchedule | Obtains the scheduling plan for a quota plan. |
Project Management
|
API |
Title |
Description |
| Basic Management (Project) | Basic Management (Project) | |
| CreateProject | CreateProject | Creates a MaxCompute project. |
| ListProjects | ListProjects | Queries a list of MaxCompute projects. |
| GetProject | GetProject | Queries the basic information about a MaxCompute project. |
| UpdateProjectBasicMeta | UpdateProjectBasicMeta | Update Project Basic Information |
| UpdateProjectDefaultQuota | UpdateProjectDefaultQuota | Updates the default computing quota of a project. |
| UpdateProjectIpWhiteList | UpdateProjectIpWhiteList | Modifies the IP address whitelist of a MaxCompute project. |
| GetTrustedProjects | GetTrustedProjects | Obtains the trusted projects of the current project. |
| DeleteProject | DeleteProject | Deletes a MaxCompute project. This operation is irreversible. Use this API with caution. |
| Role Permissions | Role Permissions | |
| ListProjectUsers | ListProjectUsers | Queries a list of users in a project. |
| CreateRole | CreateRole | Creates a role at the MaxCompute project level. |
| ListRoles | ListRoles | Obtains MaxCompute project-level roles. |
| GetRoleAcl | GetRoleAcl | Obtains the ACL-based permissions that is granted to a project-level role. |
| GetRoleAclOnObject | GetRoleAclOnObject | Obtains ACL-based permissions on an object that are granted to a project-level role. |
| GetRolePolicy | GetRolePolicy | Obtains the policy that is attached to a project-level role. |
| ListUsersByRole | ListUsersByRole | Obtains information about the users who are assigned a project-level role. |
| UpdateUsersToRole | UpdateUsersToRole | Adds or removes users from a project role. |
| Package | Package | |
| ListPackages | ListPackages | Queries the packages in a MaxCompute project. |
| UpdatePackage | UpdatePackage | Updates the objects in a package and projects in which the package can be installed. |
| CreatePackage | CreatePackage | Creates a package. |
| GetPackage | GetPackage | Obtains the information about a package. |
| Table | Table | |
| ListTables | ListTables | Obtains tables in a MaxCompute project. |
| GetTableInfo | GetTableInfo | Views the information about MaxCompute internal tables, views, external tables, clustered tables, or transactional tables. |
| Function | Function | |
| ListFunctions | ListFunctions | Obtains functions in a MaxCompute project. |
| Resources | Resources | |
| ListResources | ListResources | Obtains resources in a MaxCompute project. |
Tenant Management
|
API |
Title |
Description |
| ListUsers | ListUsers | Obtains users in a MaxCompute project. |
Resource Observation
|
API |
Title |
Description |
| QueryQuotaMetric | QueryQuotaMetric | Queries the time series data of resource consumption for a quota. |
| QueryTunnelMetricDetail | QueryTunnelMetricDetail | Queries detailed data for the Tunnel Data Transmission Service within a specified time range. |
| QueryTunnelMetric | QueryTunnelMetric | Queries metric data for the Tunnel Data Transmission Service within a specified time range. |
| GetQuotaUsage | GetQuotaUsage | Queries quota resource consumption information. |
| ListJobMetric | ListJobMetric | Queries a performance metric of the job that is complete. |
| QueryStorageMetric | QueryStorageMetric | Queries time-series metrics of data storage. |
| ListStorageTablesInfo | ListStorageTablesInfo | Queries the table storage details of a MaxCompute project. |
| ListStoragePartitionsInfo | ListStoragePartitionsInfo | Queries the storage details of a specific partition in a partitioned table in a MaxCompute project. |
| GetStorageSizeSummary | GetStorageSizeSummary | Retrieves a summary of storage usage. |
| GetStorageAmountSummary | GetStorageAmountSummary | Retrieves a summary of the total storage amount. |
| GetStorageSummaryCompared | GetStorageSummaryCompared | Retrieves the year-on-year (YoY) change in storage usage. |
| ListStorageProjectsInfo | ListStorageProjectsInfo | Retrieves the storage details of projects. |
| SumStorageMetricsByDate | SumStorageMetricsByDate | Retrieves the storage information for each category or project on a specified date. |
Job Management
|
API |
Title |
Description |
| ListJobInfos | ListJobInfos | Views a list of jobs. |
| ListJobSnapshotInfos | ListJobSnapshotInfos | Views a list of job snapshot data at a specific point in time. |
| GetJobInfo | GetJobInfo | Queries the basic information about a job. |
| GetRunningJobs | GetRunningJobs | Obtains the running state data of jobs that are in the running state in a specified period of time. |
| KillJobs | KillJobs | Terminates a running job. |
| GetJobResourceUsage | GetJobResourceUsage | Performs statistics on all jobs that are complete on a specified day and obtains the total resource usage of each job executor on a daily basis. |
Data Migration
|
API |
Title |
Description |
| CreateMmsDataSource | CreateMmsDataSource | Creates a data source to migrate data to MaxCompute using MaxCompute Migration Assist (MMA). |
| GetMmsDataSource | GetMmsDataSource | Retrieves the details of a specific MaxCompute Migration Assist (MMA) data source. |
| ListMmsDataSources | ListMmsDataSources | Lists the MaxCompute Migration Assist (MMA) data sources. |
| UpdateMmsDataSource | UpdateMmsDataSource | Refreshes the metadata of a MaxCompute Migration Assist (MMA) data source. |
| DeleteMmsDataSource | DeleteMmsDataSource | Deletes a MaxCompute Migration Assist (MMA) data source and its associated migration plans and metadata. |
| CreateMmsFetchMetadataJob | CreateMmsFetchMetadataJob | Creates a job to pull metadata from a data source. |
| GetMmsFetchMetadataJob | GetMmsFetchMetadataJob | Retrieves the details of a MaxCompute Migration Assist (MMA) job that fetches metadata. |
| ListMmsDbs | ListMmsDbs | Lists the databases in a MaxCompute Migration Assist (MMA) data source. |
| GetMmsDb | GetMmsDb | Retrieves a database from a MaxCompute Migration Assist (MMA) data source. |
| ListMmsTables | ListMmsTables | Lists the tables in a MaxCompute Migration Assist (MMA) data source. |
| GetMmsTable | GetMmsTable | Retrieves a table from a MaxCompute Migration Assist (MMA) data source. |
| ListMmsPartitions | ListMmsPartitions | Lists the partitions in a MaxCompute Migration Assist (MMA) data source. |
| GetMmsPartition | GetMmsPartition | Retrieves a partition from a MaxCompute Migration Assist (MMA) data source. |
| CreateMmsJob | CreateMmsJob | Creates a data migration task. |
| ListMmsJobs | ListMmsJobs | Retrieves a list of migration jobs. |
| GetMmsJob | GetMmsJob | Retrieves the details of a specific MaxCompute Migration Assist (MMA) migration plan. |
| GetMmsAsyncTask | GetMmsAsyncTask | Retrieves a single asynchronous task from MaxCompute Migration Assist (MMA). |
| DeleteMmsJob | DeleteMmsJob | Deletes a MaxCompute Migration Assist (MMA) data migration plan. |
| StartMmsJob | StartMmsJob | Starts a data migration job. |
| StopMmsJob | StopMmsJob | Stops a data migration job. |
| RetryMmsJob | RetryMmsJob | Retries a data migration job. |
| ListMmsTasks | ListMmsTasks | Retrieves a list of migration tasks. |
| GetMmsTask | GetMmsTask | Retrieves the details of a specific migration task. |
| ListMmsTaskLogs | ListMmsTaskLogs | Lists the execution logs for a specific migration task. |
Cost Analysis
|
API |
Title |
Description |
| ListComputeMetricsByInstance | ListComputeMetricsByInstance | Queries a list of computing resources used by a pay-as-you-go job. |