Selecting an API Type
Currently, MRS provides two types (V1.1 and V2) of APIs for cloud services with customized specifications. Only part of V2 APIs is available and mainly used for submitting jobs and SQL statements. If the API functions are the same, you are advised to use the V2 APIs first.
- All MRS versions support the V1.1 APIs.
- For MRS 1.X clusters, MRS 1.8.7 or later supports the V2 APIs.
- For MRS 2.X clusters, MRS 2.0.3 or later supports the V2 APIs.
Based on the V1.1 APIs, the V2 APIs have the following enhancements:
- Jobs can be submitted in a security cluster.
- The HiveSQL, Spark Python, and Flink jobs are supported.
- The SparkSQL and SparkScript results can be queried.
For details about the APIs and their functions, see API Overview.
API Throttling
MRS has an upper limit on the number of calls that can be made to server APIs. This prevents service interruptions caused by repeated API calls in a short period of time.

If the error message "APIGW.0308" is returned when an MRS API is called, API throttling is triggered. In this case, adjust the API calling interval to control the request sending speed or send API requests later.
Version |
API Category |
API Name |
Single-Tenant API Throttling |
---|---|---|---|
V2 |
Cluster Management |
Creating a Cluster |
60 requests/minute |
Changing a Cluster Name |
60 requests/minute |
||
Creating a Cluster and Submitting a Job |
60 requests/minute |
||
Scaling Out a Cluster |
60 requests/minute |
||
Scaling In a Cluster |
60 requests/minute |
||
Adding Components to a Cluster |
60 requests/minute |
||
Querying Cluster Nodes |
200 requests/minute |
||
Job Management |
Adding and Executing a Job |
60 requests/minute |
|
Querying Jobs |
1000 requests/minute |
||
Querying a Job |
1000 requests/minute |
||
Terminating a Job |
60 requests/minute |
||
Obtaining SQL Statement Execution Results |
1000 requests/minute |
||
Deleting Jobs |
60 requests/minute |
||
Auto Scaling |
Viewing an Auto Scaling Policy |
1000 requests/minute |
|
Updating an Auto Scaling Policy |
60 requests/minute |
||
Deleting an Auto Scaling Policy |
60 requests/minute |
||
Creating an Auto Scaling Policy |
60 requests/minute |
||
Cluster HDFS File |
Obtaining Files from a Specified Directory |
1000 requests/minute |
|
SQL |
Submitting an SQL Statement |
60 requests/minute |
|
Querying SQL Statement Execution Results |
1000 requests/minute |
||
Canceling an SQL Execution Job |
60 requests/minute |
||
Agency Management |
Querying the Mapping Between a User (Group) and an IAM Agency |
1000 requests/minute |
|
Updating the Mapping Between a User (Group) and an IAM Agency |
60 requests/minute |
||
Data Connection Management |
Creating a Data Connection |
60 requests/minute |
|
Querying Data Connections |
1000 requests/minute |
||
Updating a Data Connection |
60 requests/minute |
||
Deleting a Data Connection |
60 requests/minute |
||
Version Metadata Query |
Obtaining MRS Versions |
1000 requests/minute |
|
Querying Available Specifications of an MRS Cluster Version |
1000 requests/minute |
||
IAM Synchronization Management |
Obtaining Synchronized IAM Users and User Groups |
1000 requests/minute |
|
Synchronizing IAM Users and User Groups |
60 requests/minute |
||
Cancelling Synchronization of Specified Users and User Groups |
60 requests/minute |
||
Tag Management |
Enabling/Disabling Default Cluster Tags |
60 requests/minute |
|
Querying the Status of the Default Cluster Tag |
1000 requests/minute |
||
Querying the Tag Quotas |
1000 requests/minute |
||
V1.1 |
Cluster Management |
Creating a Cluster and Executing a Job |
60 requests/minute |
Resizing a Cluster |
60 requests/minute |
||
Listing All Clusters |
1000 requests/minute |
||
Querying Cluster Details |
1000 requests/minute |
||
Listing All Hosts |
1000 requests/minute |
||
Deleting a Cluster |
60 requests/minute |
||
Auto Scaling |
Configuring an Auto Scaling Rule |
60 requests/minute |
|
Tag Management |
Adding Tags to a Specified Cluster |
60 requests/minute |
|
Querying Tags of a Specified Cluster |
1000 requests/minute |
||
Deleting Tags of a Specified Cluster |
60 requests/minute |
||
Adding Tags to a Cluster |
60 requests/minute |
||
Deleting Tags of a Cluster |
60 requests/minute |
||
Querying All Tags |
1000 requests/minute |
||
Querying the Clusters with Specified Tags |
1000 requests/minute |
||
AZ |
Querying AZ Information |
1000 requests/minute |
|
Version Metadata Query |
Querying Metadata of a Specific Cluster Version |
1000 requests/minute |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot