tencent cloud

APIs

DokumentasiAPIsElastic MapReduceServerless HBase APIsDescribeSLInstanceList

DescribeSLInstanceList

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-10 14:58:07

1. API Description

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

This API is used to query 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: Queries the list of instances except for those that have been terminated.
  • monitorManage: Queries 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 items returned per page. Default value: 10. Maximum value: 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 instances that meet the criteria.
    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": "The cluster is being created.",
                "SubnetId": 2666622,
                "Tags": [],
                "VpcId": 11406751,
                "Zone": "ap-guangzhou-2",
                "ZoneId": 100002
            }
        ],
        "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 Internal service call exception.
    InternalError.CamCgwError Internal service call exception.
    InternalError.CamError Internal service call exception.
    InternalError.CbsCgwError Internal service call exception.
    InternalError.CbsError Internal service call exception.
    InternalError.CdbCgwError Internal service call exception.
    InternalError.CdbError Internal service call exception.
    InternalError.CheckQuotaErr Insufficient CVM or CBS resources, or invalid software.
    InternalError.ConfigCgwError Internal service call exception.
    InternalError.CvmError Internal service call exception.
    InternalError.KmsError Internal service call exception.
    InternalError.ProjectCgwError Internal service call exception.
    InternalError.SgError An exception occurred when the security group API is called.
    InternalError.TagError Internal service call exception.
    InternalError.TradeCgwError Internal service call exception.
    InternalError.VpcCgwError Internal service call exception.
    InternalError.VpcError Internal service call exception.
    InvalidParameter Parameter error.
    InvalidParameter.DisplayStrategyNotMatch Display policy error.
    InvalidParameter.InvalidAutoRenew Invalid auto-renewal flag.
    InvalidParameter.InvalidClientToken Invalid ClientToken.
    InvalidParameter.InvalidComponent Invalid component.
    InvalidParameter.InvalidCoreCount Invalid Core node quantity.
    InvalidParameter.InvalidDiskSize Invalid disk size.
    InvalidParameter.InvalidExtendField Invalid CustomConfig parameter value.
    InvalidParameter.InvalidInstanceName Invalid cluster name.
    InvalidParameter.InvalidInstanceType Invalid instance type.
    InvalidParameter.InvalidLoginSetting Invalid login settings.
    InvalidParameter.InvalidMetaType Invalid metadata table type.
    InvalidParameter.InvalidPassword Invalid password.
    InvalidParameter.InvalidPaymode Invalid payment type.
    InvalidParameter.InvalidPreExecutedFile Invalid bootstrap operation script.
    InvalidParameter.InvalidProductId Invalid product ID.
    InvalidParameter.InvalidProjectId Invalid project ID.
    InvalidParameter.InvalidResourceSpec Invalid resource specifications.
    InvalidParameter.InvalidSercurityGrpupId Invalid security group ID.
    InvalidParameter.InvalidServiceName Invalid service name.
    InvalidParameter.InvalidSoftDeployInfo The InvalidSoftDeployInfo parameter is invalid or incorrect.
    InvalidParameter.InvalidSoftInfo The SoftInfo parameter is invalid.
    InvalidParameter.InvalidSoftWare Parameter error.
    InvalidParameter.InvalidSoftWareName Invalid software name.
    InvalidParameter.InvalidSoftWareVersion Invalid software version.
    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. It does not contain required components.
    InvalidParameter.OrderFieldNotMatch Sorting field error.
    InvalidParameter.PayModeResourceNotMatch The payment mode does not match resources.
    InvalidParameter.SoftwareNotInProduct Invalid product components exist.
    InvalidParameter.UngrantedPolicy The policy is authorization.
    InvalidParameter.UngrantedRole Role not authorized.
    InvalidParameter.ZoneResourceNotMatch The AZ does not match resources.
    InvalidParameterValue Parameter value error.
    MissingParameter Missing parameter error.
    ResourceInsufficient.DiskInsufficient The specifications of the hard disk do not meet the requirements.
    ResourceInsufficient.InstanceInsufficient The node specifications are not supported or have been sold out.
    ResourceNotFound.TagsNotFound The specified tag is not found.
    ResourcesSoldOut Resources have been sold out.
    ResourcesSoldOut.CbsSoldOut CBS resources have been sold out.
    ResourcesSoldOut.CvmSoldOut CVMs have been sold out.
    UnauthorizedOperation.CheckCamAuth No permission to verify account operations.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation The operation is not supported.
    Topik sebelumnya: ModifySLInstanceBasicTopik selanjutnya: ModifySLInstance

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan

    Search
      Enter keywords to search documentation