This product(
MaxCompute/2022-01-04) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Quota Management
| API | Title | Description |
|---|---|---|
| ListQuotas | ListQuotas | Queries quotas. |
| QueryQuota | QueryQuota | Queries the information about a specified level-1 quota group. |
| GetQuota | GetQuota | Obtains the information about a specified level-1 quota. |
| 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 | Update the time-based plan for computing quota. |
| GetComputeEffectivePlan | GetComputeEffectivePlan | GetComputeEffectivePlan. |
| Tunnel Quota | Tunnel Quota | |
| ListTunnelQuotaTimer | ListTunnelQuotaTimer | Displays the time-specific configuration of an exclusive resource group for Tunnel (referred to as Tunnel quota). |
| UpdateTunnelQuotaTimer | UpdateTunnelQuotaTimer | Updates the time-specific configuration of an exclusive resource group for Tunnel (referred to as 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 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. |
| 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. |
| 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 |
|---|---|---|
| GetQuotaUsage | GetQuotaUsage | Queries quota resource consumption information. |
| ListJobMetric | ListJobMetric | Queries a performance metric of the job that is complete. |
| 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. |
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. |
Cost Analysis
| API | Title | Description |
|---|---|---|
| ListComputeMetricsByInstance | ListComputeMetricsByInstance | Queries a list of computing resources used by a pay-as-you-go job. |