API standards and multilingual preset SDKs
The OpenAPI of this product (MaxCompute/2022-01-04) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Quota management
|
API |
Title |
Description |
| CreateQuota | Create a quota | Creates a quota. When you activate MaxCompute for the first time, you must first create a pay-as-you-go quota. If you create a subscription quota, automatic payment is deducted. |
| 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 configuration | Compute quota configuration | |
| CreateComputeQuotaPlan | CreateComputeQuotaPlan | Creates a quota plan. |
| UpdateComputeSubQuota | UpdateComputeSubQuota | Updates the basic configuration of a MaxCompute quota, including adding or deleting level-2 quotas, defining the basic attributes of a level-2 quota, and configuring compute units (CUs) for a quota plan that is in effect. |
| GetComputeQuotaPlan | GetComputeQuotaPlan | Get detailed information of a single compute quota plan. |
| ListComputeQuotaPlan | ListComputeQuotaPlan | Lists compute quota plans. |
| 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 time-based configuration | Tunnel quota time-based configuration | |
| Compute quota configuration (legacy, not recommended) | Compute quota configuration (legacy, 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) | |
| UpdateProjectBasicMeta | UpdateProjectBasicMeta | Modifies the basic information of a project. |
| UpdateProjectDefaultQuota | UpdateProjectDefaultQuota | Updates the default computing quota of a project. |
| UpdateProjectIpWhiteList | UpdateProjectIpWhiteList | Modifies the IP address whitelist of a MaxCompute project. |
| UpdateProjectModelTier | UpdateProjectModelTier | Upgrades a project's Layer 2 model to a Layer 3 model. |
| GetTrustedProjects | GetTrustedProjects | Obtains the trusted projects of the current project. |
| Roles and permissions (Role, user) | Roles and permissions (Role, user) | |
| DeleteRole | DeleteRole | Deletes a project-level role in MaxCompute. |
| ListProjectUsers | ListProjectUsers | Queries a list of users in a project. |
| CreateRole | CreateRole | Creates a role at the MaxCompute project level. |
| 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. |
| Tables (Table) | Tables (Table) | |
| GetTableInfo | GetTableInfo | Views the information about MaxCompute internal tables, views, external tables, clustered tables, or transactional tables. |
Resource monitoring
|
API |
Title |
Description |
| QueryQuotaMetric | QueryQuotaMetric | Queries the time series data of resource consumption for a quota. |
| QueryTunnelMetricDetail | QueryTunnelMetricDetail | Queries details about the Tunnel Data Transmission Service for 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 | Retrieves storage details for the partitions of 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. |
Job O&M
|
API |
Title |
Description |
| ListJobInfos | ListJobInfos | Retrieves a list of jobs. |
| ListJobSnapshotInfos | ListJobSnapshotInfos | Retrieves job snapshot data at a specific point in time. |
| GetJobInfo | GetJobInfo | Queries 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 |
| RetryMmsTask | RetryMmsTask | Retries a migration task. |
| CreateMmsDataSource | CreateMmsDataSource | Creates a data source to migrate data to MaxCompute using MaxCompute Migration Assist (MMA). |
| GetMmsDataSource | GetMmsDataSource | Retrieves the details of a single MaxCompute Migration Assist (MMA) data source. |
| ListMmsDataSources | ListMmsDataSources | 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 | List databases in the 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 | Lists migration jobs. |
| GetMmsJob | GetMmsJob | Retrieves the details of a single 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 | Retrieve data migration task list | Retrieves a list of data migration tasks. |
| GetMmsTask | GetMmsTask | Retrieves the details of a specific migration task. |
| ListMmsTaskLogs | ListMmsTaskLogs | Lists the execution logs for a specific migration task. |
| CreateMmsTimer | CreateMmsTimer | CreateMmsTimer |
| UpdateMmsTimer | UpdateMmsTimer | Updates the settings of a scheduled task. |
| UpdateMmsTables | UpdateMmsTables | Updates table metadata. |
| UpdateMmsTable | UpdateMmsTable | Updates table metadata. |
| UpdateMmsDb | UpdateMmsDb | Updates the metadata of a specified database. |
| ListMmsTimers | ListMmsTimers | Lists the timers for a specified data source. |
| ListMmsTimerLogs | ListMmsTimerLogs | Lists the logs of a scheduled task for a specific data source. |
| ListMmsDataSourceConfigItems | ListMmsDataSourceConfigItems | Lists the configuration items for a specified data source type. |
| GetMmsTimer | GetMmsTimer | GetMmsTimer |
| DeleteMmsTimer | DeleteMmsTimer | Deletes a timer from a specified data source. |
Cost analysis
|
API |
Title |
Description |
| ListInstances | ListInstances | Retrieves a list of projects for cost analysis over a specified time period. |
| SumStorageMetricsByType | SumStorageMetricsByType | Aggregates storage usage by storage type. |
| ListComputeMetricsBySignature | ListComputeMetricsBySignature | View detailed compute usage for jobs by Signature. |
| SumComputeMetricsByUsage | SumComputeMetricsByUsage | Aggregates compute usage by scanned data volume or CU usage. |
| SumComputeMetricsByRecord | SumComputeMetricsByRecord | Calculates the total number of usage records. |
| SumDailyBillsByItem | SumDailyBillsByItem | View a daily breakdown of costs by instance or billable item. |
| SumBills | SumBills | Summarizes cost information by instance or billable item. |
| SumBillsByDate | SumBillsByDate | Retrieves a daily summary of costs, grouped by instance or billable item. |
| SumStorageMetricsByDate | SumStorageMetricsByDate | Retrieves aggregated storage metrics over a specified date range, grouped by project or storage class. |
| ListComputeMetricsByInstance | ListComputeMetricsByInstance | Lists the compute usage for jobs per instance. |
Others
|
API |
Title |
Description |
| TriggerMmsTimer | TriggerMmsTimer | Triggers a timer for a specific datasource. |
| CreateProject | CreateProject | Creates a MaxCompute project. |
| DeleteProject | DeleteProject | Deletes a MaxCompute project. This operation is irreversible. Use this API with caution. |
| GetProject | GetProject | Queries the basic information of a MaxCompute project. |
| ListFunctions | ListFunctions | Obtains functions in a MaxCompute project. |
| ListProjects | ListProjects | Retrieves a list of MaxCompute projects. |
| ListResources | ListResources | Obtains resources in a MaxCompute project. |
| ListRoles | ListRoles | Obtains MaxCompute project-level roles. |
| ListTables | ListTables | Obtains tables in a MaxCompute project. |
| ListUsers | ListUsers | Obtains users in a MaxCompute project. |