tencent cloud

Elastic MapReduce

Release Notes and Announcements
Release Notes
Announcements
Security Announcements
Product Introduction
Overview
Strengths
Architecture
Features
Use Cases
Constraints and Limits
Technical Support Scope
Product release
Purchase Guide
EMR on CVM Billing Instructions
EMR on TKE Billing Instructions
EMR Serverless HBase Billing Instructions
Getting Started
EMR on CVM Quick Start
EMR on TKE Quick Start
EMR on CVM Operation Guide
Planning Cluster
Administrative rights
Configuring Cluster
Managing Cluster
Managing Service
Monitoring and Alarms
TCInsight
EMR on TKE Operation Guide
Introduction to EMR on TKE
Configuring Cluster
Cluster Management
Service Management
Monitoring and Ops
Application Analysis
EMR Serverless HBase Operation Guide
EMR Serverless HBase Product Introduction
Quotas and Limits
Planning an Instance
Managing an Instance
Monitoring and Alarms
Development Guide
EMR Development Guide
Hadoop Development Guide
Spark Development Guide
Hbase Development Guide
Phoenix on Hbase Development Guide
Hive Development Guide
Presto Development Guide
Sqoop Development Guide
Hue Development Guide
Oozie Development Guide
Flume Development Guide
Kerberos Development Guide
Knox Development Guide
Alluxio Development Guide
Kylin Development Guide
Livy Development Guide
Kyuubi Development Guide
Zeppelin Development Guide
Hudi Development Guide
Superset Development Guide
Impala Development Guide
Druid Development Guide
TensorFlow Development Guide
Kudu Development Guide
Ranger Development Guide
Kafka Development Guide
Iceberg Development Guide
StarRocks Development Guide
Flink Development Guide
JupyterLab Development Guide
MLflow Development Guide
Practical Tutorial
Practice of EMR on CVM Ops
Data Migration
Practical Tutorial on Custom Scaling
API Documentation
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
FAQs
EMR on CVM
Service Level Agreement
Contact Us

DescribeSLInstanceList

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-11-13 20:48:55

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to query the detailed information of the Serverless HBase instance list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeSLInstanceList.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DisplayStrategy Yes String Instance filtering policy. Valid values:
  • clusterList: Query the list of instances except for those that have been terminated.
  • monitorManage: Query the list of instances except for those that have been terminated, are being created, or fail to be created.
  • Offset No Integer Page number. The default value is 0, indicating the first page.
    Limit No Integer Number of records to be returned per page. The default value is 10, and the maximum value is 100.
    OrderField No String Sorting field. Valid values:
  • clusterId: Sort by instance ID.
  • addTime: Sort by instance creation time.
  • status: Sort by instance status code.
  • Asc No Integer Sorts by OrderField in ascending or descending order. Valid values:
  • 0: ascending order;
  • 1: descending order.
  • The default value is 0.
    Filters.N No Array of Filters Custom search filters. Examples:
  • Filter instances by ClusterId: [{"Name":"ClusterId","Values":["emr-xxxxxxxx"]}]
  • Filter instances by clusterName: [{"Name": "ClusterName","Values": ["cluster_name"]}]
  • Filter instances by ClusterStatus: [{"Name": "ClusterStatus","Values": ["2"]}]
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCnt Integer Total number of qualified instances .
    InstancesList Array of SLInstanceInfo Instance information list. If pagination is applied, only the current page's instance information list is displayed.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the Serverless HBase Instance List

    This example shows you how to query the Serverless HBase instance list.

    Input Example

    POST / HTTP/1.1
    Host: emr.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeSLInstanceList
    <Common request parameters>
    
    {
        "Offset": 0,
        "Limit": 10,
        "OrderField": "AddTime",
        "Asc": 1,
        "DisplayStrategy": "clusterList",
        "Filters": []
    }

    Output Example

    {
        "Response": {
            "InstancesList": [
                {
                    "AddTime": "2024-03-14 17:40:19",
                    "AppId": 251233704,
                    "ClusterId": "emr-2ecolb9q",
                    "ClusterName": "EMR-haosen",
                    "Id": 126358006,
                    "PayMode": 0,
                    "RegionId": 1,
                    "Status": 3,
                    "StatusDesc": "Cluster in production",
                    "SubnetId": 2666622,
                    "Tags": [],
                    "VpcId": 11406751,
                    "Zone": "ap-guangzhou-6",
                    "ZoneId": 100006
                }
            ],
            "RequestId": "fde6361c-205a-45e5-8bec-34b9100fc5b0",
            "TotalCnt": 1
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.DuplicateOrderNotAllowed Duplicate order. Please check the EMR console.
    InternalError Internal error.
    InternalError.AccountCgwError An error occurred while calling another service API.
    InternalError.CamCgwError An error occurred while calling another service API.
    InternalError.CamError An error occurred while calling another service API.
    InternalError.CbsCgwError An error occurred while calling another service API.
    InternalError.CbsError An error occurred while calling another service API.
    InternalError.CdbCgwError An error occurred while calling another service API.
    InternalError.CdbError An error occurred while calling another service API.
    InternalError.CheckQuotaErr CVM or CBS resources are insufficient, or the software is invalid.
    InternalError.ConfigCgwError An error occurred while calling another service API.
    InternalError.CvmError An error occurred while calling another service API.
    InternalError.KmsError An error occurred while calling another service API.
    InternalError.ProjectCgwError An error occurred while calling another service API.
    InternalError.SgError An error occurred when calling a security group API.
    InternalError.TagError An error occurred while calling another service API.
    InternalError.TradeCgwError An error occurred while calling another service API.
    InternalError.VpcCgwError An error occurred while calling another service API.
    InternalError.VpcError An error occurred while calling another service API.
    InvalidParameter Invalid parameter.
    InvalidParameter.DisplayStrategyNotMatch Incorrect display policy.
    InvalidParameter.InvalidAutoRenew Invalid auto-renewal flag.
    InvalidParameter.InvalidClientToken Invalid ClientToken.
    InvalidParameter.InvalidComponent Invalid component.
    InvalidParameter.InvalidCoreCount The number of core nodes is invalid.
    InvalidParameter.InvalidDiskSize Invalid disk size.
    InvalidParameter.InvalidExtendField Invalid CustomConfig.
    InvalidParameter.InvalidInstanceName Invalid cluster name.
    InvalidParameter.InvalidInstanceType Invalid model.
    InvalidParameter.InvalidLoginSetting Invalid login settings.
    InvalidParameter.InvalidMetaType Invalid metadata table type.
    InvalidParameter.InvalidPassword Invalid password.
    InvalidParameter.InvalidPaymode Invalid billing mode.
    InvalidParameter.InvalidPreExecutedFile Invalid bootstrap script.
    InvalidParameter.InvalidProductId Invalid product ID.
    InvalidParameter.InvalidProjectId Invalid project ID.
    InvalidParameter.InvalidResourceSpec Invalid resource specification.
    InvalidParameter.InvalidSercurityGrpupId Invalid security group ID.
    InvalidParameter.InvalidServiceName The service name is invalid.
    InvalidParameter.InvalidSoftDeployInfo The InvalidSoftDeployInfo parameter is invalid or incorrect.
    InvalidParameter.InvalidSoftInfo Invalid SoftInfo.
    InvalidParameter.InvalidSoftWare Incorrect parameter.
    InvalidParameter.InvalidSoftWareName The software name is invalid.
    InvalidParameter.InvalidSoftWareVersion The software version is invalid.
    InvalidParameter.InvalidSubnetId Invalid subnet ID.
    InvalidParameter.InvalidSupportHA Invalid high availability parameter.
    InvalidParameter.InvalidTimeSpan Invalid timespan.
    InvalidParameter.InvalidTimeUnit Invalid TimeUnit.
    InvalidParameter.InvalidVpcId Invalid VPC ID.
    InvalidParameter.InvalidZone Invalid AZ.
    InvalidParameter.NotContainMustSelectSoftware Invalid parameter. Necessary components are missing.
    InvalidParameter.OrderFieldNotMatch Invalid sorting field.
    InvalidParameter.PayModeResourceNotMatch The billing mode and resource do not match.
    InvalidParameter.SoftwareNotInProduct There is an invalid product component.
    InvalidParameter.UngrantedPolicy The policy is not authorized.
    InvalidParameter.UngrantedRole The role is not authorized.
    InvalidParameter.ZoneResourceNotMatch The AZ and resource do not match.
    InvalidParameterValue Incorrect parameter value.
    MissingParameter Missing parameter.
    ResourceInsufficient.DiskInsufficient The disk specification is insufficient.
    ResourceInsufficient.InstanceInsufficient The node specification is unsupported or has been sold out.
    ResourceNotFound.TagsNotFound No specified tag found.
    ResourcesSoldOut The resources have been sold out.
    ResourcesSoldOut.CbsSoldOut The CBS resources have been sold out.
    ResourcesSoldOut.CvmSoldOut CVM instances have been sold out.
    UnauthorizedOperation.CheckCamAuth Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백