API standards and multilingual preset SDKs
The OpenAPI of this product (Emr/2021-03-20) uses the RPC 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.
Basics
|
API |
Title |
Description |
| ListReleaseVersions | ListReleaseVersions | Queries the major E-MapReduce (EMR) versions. |
| ListInstanceTypes | ListInstanceTypes | Retrieves a list of EMR instance types. |
Cluster
|
API |
Title |
Description |
| RunCluster | RunCluster | Creates a pay-as-you-go or subscription cluster. |
| CreateCluster | CreateCluster | Creates a pay-as-you-go or subscription cluster. |
| UpdateClusterAttribute | UpdateClusterAttribute | Updates cluster attributes. |
| ListClusters | ListClusters | Lists EMR clusters. |
| DeleteCluster | DeleteCluster | Deletes a pay-as-you-go cluster. |
| GetClusterCloneMeta | GetClusterCloneMeta | Retrieves the clone metadata of an E-MapReduce (EMR) cluster. You can use this metadata to quickly create a cluster by calling the CreateCluster operation. |
| UpdateClusterAutoRenew | UpdateClusterAutoRenew | Enables or disables auto-renewal for an EMR cluster and its Elastic Compute Service (ECS) instances. |
Cluster template
|
API |
Title |
Description |
| CreateApiTemplate | CreateApiTemplate | Creates a predefined API operation template. The template contains information about an API operation, including the basic structure, request method, URL path, request parameters, and response format. |
| UpdateApiTemplate | UpdateApiTemplate | Updates an API operation template. |
| ListApiTemplates | ListApiTemplates | Lists API templates. |
| RunApiTemplate | RunApiTemplate | Runs an API template. |
Node group
|
API |
Title |
Description |
| CreateNodeGroup | CreateNodeGroup | Creates a node group. |
| ListNodeGroups | ListNodeGroups | Queries the node groups in an EMR cluster. |
| GetNodeGroup | GetNodeGroup | Queries the details of a node group. |
| IncreaseNodes | IncreaseNodes | Scales out a target node group. |
| DecreaseNodes | DecreaseNodes | Scales in a target node group. |
Auto scaling
|
API |
Title |
Description |
| PutAutoScalingPolicy | PutAutoScalingPolicy | Creates a custom Auto Scaling policy. |
| GetAutoScalingPolicy | GetAutoScalingPolicy | Retrieves the details of a custom Auto Scaling policy. |
| GetManagedScalingPolicy | GetManagedScalingPolicy | Retrieves the details of a managed scaling policy. |
| ListAutoScalingActivities | ListAutoScalingActivities | Lists Auto Scaling activities. |
| GetAutoScalingActivity | GetAutoScalingActivity | Retrieves the details of an Auto Scaling activity. |
Application
|
API |
Title |
Description |
| GetApplication | GetApplication | Retrieves the details of an application. |
| RunApplicationAction | RunApplicationAction | Manages a service deployed in a cluster. For example, you can call this operation to start pr stop a service. |
| ListApplicationConfigs | ListApplicationConfigs | Queries the configurations of the application. |
| UpdateApplicationConfigs | UpdateApplicationConfigs | Updates the configurations of an application. |
| ListComponents | ListComponents | Retrieves a list of components. |
| ListComponentInstances | ListComponentInstances | Retrieves the list of component instances. |
Operation
|
API |
Title |
Description |
| UntagResources | UntagResources | Unbinds tags from a specified column in an EMR cluster. If the tag is not bound to other resources, the tag is automatically deleted. |
| ListTagResources | ListTagResources | Queries the tags attached to E-MapReduce (EMR) clusters. |
Resource group
|
API |
Title |
Description |
| CreateScript | CreateScript | Creates a bootstrap script or a regular cluster script. |
| ListScripts | ListScripts | Queries the bootstrap or normal scripts of an EMR cluster. |
| UpdateScript | UpdateScript | Updates a bootstrap action or a common script of an E-MapReduce (EMR) cluster. |
Tag
|
API |
Title |
Description |
| ListDoctorHiveDatabases | ListDoctorHiveDatabases | Obtains the analysis results of multiple Hive databases at a time. |
| GetDoctorHiveDatabase | GetDoctorHiveDatabase | Obtains the analysis results of a Hive database. |
| ListDoctorHiveTables | ListDoctorHiveTables | Obtains the analysis results of multiple Hive tables at a time on E-MapReduce (EMR) Doctor. |
| GetDoctorHiveTable | GetDoctorHiveTable | Obtains the analysis results of a specific Hive table in a cluster on E-MapReduce (EMR) Doctor. |
| ListDoctorHDFSUGI | ListDoctorHDFSUGI | Obtains the analysis results of Hadoop Distributed File System (HDFS) storage resources for multiple owners or groups at a time on E-MapReduce (EMR) Doctor. |
| ListDoctorHBaseTables | ListDoctorHBaseTables | Obtains the information about multiple HBase tables at a time. |
| ListDoctorHBaseRegionServers | ListDoctorHBaseRegionServers | Obtains the information about multiple HBase RegionServers at a time. |
| GetDoctorHBaseTable | GetDoctorHBaseTable | Get HBase Table information. |
| GetDoctorHBaseCluster | GetDoctorHBaseCluster | Obtains the metrics of an HBase cluster. |
| ListDoctorReports | ListDoctorReports | Obtains the overall analysis result reports of E-MapReduce (EMR) Doctor at a time. |
| GetDoctorReportComponentSummary | GetDoctorReportComponentSummary | Obtain the analysis result report of a specified component from EMR Doctor. |
| GetDoctorJob | GetDoctorJob | Obtains the basic running information about a job on E-MapReduce (EMR) Doctor. |
| ListDoctorApplications | ListDoctorApplications | Obtains the analysis results of multiple jobs on E-MapReduce (EMR) Doctor. |
| ListDoctorHDFSDirectories | ListDoctorHDFSDirectories | Retrieves batch analysis results for specific directories using EMR Doctor. The directory depth cannot exceed five levels. |
| GetDoctorApplication | GetDoctorApplication | Obtains job analysis information on E-MapReduce (EMR) Doctor. |
Script
|
API |
Title |
Description |
| CreateUsers | CreateUsers | Creates users in a batch. |
| DeleteUsers | DeleteUsers | Deletes multiple users at a time. |
| UpdateUserAttribute | UpdateUserAttribute | Updates the information about a user. |
| ListUsers | ListUsers | Queries a user. |
Monitoring and diagnostics
|
API |
Title |
Description |
| ExportApplicationConfigs | ExportApplicationConfigs | Exports the configurations of a specified service in a cluster. |
OpenLDAP user management
|
API |
Title |
Description |
| DeleteApiTemplate | DeleteApiTemplate | Deletes an API operation template. |
| DeleteNodeGroup | Delete a node group | Deletes a created cluster node group. |
| DeleteScript | DeleteScript | Deletes a bootstrap action or a common script of an E-MapReduce (EMR) cluster. |
| GetApiTemplate | GetApiTemplate | Queries the detailed configuration information about an API operation template. |
| GetCluster | GetCluster | Obtains the details of a cluster. |
| GetDoctorComputeSummary | GetDoctorComputeSummary | Obtains the information about resource usage in a cluster on E-MapReduce (EMR) Doctor. |
| GetDoctorHBaseRegion | GetDoctorHBaseRegion | Get HBase Region information. |
| GetDoctorHBaseRegionServer | GetDoctorHBaseRegionServer | Obtains the information about an HBase region server. |
| GetDoctorHDFSCluster | GetDoctorHDFSCluster | Obtains the analysis results of the Hadoop Distributed File System (HDFS) storage resources of a cluster on E-MapReduce (EMR) Doctor. |
| GetDoctorHDFSDirectory | GetDoctorHDFSDirectory | Obtains the analysis results of a specific Hadoop Distributed File System (HDFS) directory of a cluster. The depth of the directory is not greater than five. |
| GetDoctorHiveCluster | GetDoctorHiveCluster | Obtains the analysis results of a Hive cluster. |
| GetOperation | GetOperation | Gets the details of an asynchronous operation. |
| JoinResourceGroup | JoinResourceGroup | Adds an EMR resource to a resource group. A resource can belong to only one resource group. |
| ListApplications | ListApplications | Queries a list of applications. |
| ListDoctorComputeSummary | ListDoctorComputeSummary | Obtains the information about resource usage by resource type in a cluster on E-MapReduce (EMR) Doctor. |
| ListDoctorJobs | ListDoctorJobs | Obtains the basic running information about multiple jobs at a time on E-MapReduce (EMR) Doctor. |
| ListDoctorJobsStats | ListDoctorJobsStats | Obtains the summary of basic running information about multiple jobs at a time on E-MapReduce (EMR) Doctor. |
| ListNodes | ListNodes | Queries the node list of an EMR cluster. |
| RemoveAutoScalingPolicy | RemoveAutoScalingPolicy | Removes an auto scaling policy. |
| TagResources | TagResources | Binds tags to a specified EMR cluster. |
| UpdateNodeGroupAttributes | Update cluster node group attributes | Updates the attributes of a node group. |