tencent cloud

APIs

ドキュメントAPIsElastic MapReduceCluster Resource Management APIsDescribeInstancesList

DescribeInstancesList

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-10 14:59:14

1. API Description

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

This API is used to query the cluster 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: DescribeInstancesList.
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 Cluster filtering policy. Valid values:
  • clusterList: Queries the list of clusters except for those that have been terminated.
  • monitorManage: Queries the list of clusters except for those that have been terminated, are being created, or fail to be created.
  • cloudHardwareManage/componentManage: Currently these two values are reserved and temporarily have the same meaning as monitorManage.
    		•
    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: 100. Maximum value: 100.
    If both limit and offset are 0, all records will be queried.
    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"]}]
    		•
    ClusterType No Integer Default value 0 for regular clusters and 2 for TKE clusters.

    3. Output Parameters

    Parameter Name Type Description
    TotalCnt Integer Total number of instances that meet the criteria.
    InstancesList Array of EmrListInstance Cluster list.
    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 Instance Details

    This example shows you how to query instance details.

    Input Example

    POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstancesList
<Common request parameters>

{
    "Asc": 0,
    "DisplayStrategy": "clusterList",
    "Limit": 10,
    "OrderField": "clusterid",
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "InstancesList": [
            {
                "AddTime": "2024-11-04 15:54:58",
                "AlarmInfo": "",
                "AppId": 11111,
                "ChargeType": 1,
                "ClusterClass": "Hadoop",
                "ClusterId": "emr-111",
                "ClusterName": "EMR-1111",
                "EmrVersion": "",
                "Id": 1016390,
                "IsDedicatedCluster": false,
                "IsHandsCluster": false,
                "IsMultiZoneCluster": false,
                "IsSupportOutsideCluster": true,
                "IsWoodpeckerCluster": 1,
                "MasterIp": "--",
                "OutSideSoftInfo": [
                    {
                        "Required": true,
                        "SoftName": "hdfs-3.2.2"
                    },
                    {
                        "Required": true,
                        "SoftName": "yarn-3.2.2"
                    },
                    {
                        "Required": false,
                        "SoftName": "hive-3.1.3"
                    },
                    {
                        "Required": false,
                        "SoftName": "hbase-2.4.5"
                    },
                    {
                        "Required": false,
                        "SoftName": "spark-3.2.2"
                    }
                ],
                "ProductId": 44,
                "ProjectId": 1325150,
                "RegionId": 1,
                "RunTime": "1 day 5 hours 24 minutes 6 seconds",
                "Status": 2,
                "StatusDesc": "The cluster is running.",
                "SubnetId": 6059972,
                "SubnetName": "zefa-111",
                "Tags": [
                    {
                        "TagKey": "tke-111",
                        "TagValue": "cos-111"
                    }
                ],
                "UniqSubnetId": "subnet-pan0t01q",
                "UniqVpcId": "vpc-hitz5lsz",
                "VpcId": 10412940,
                "VpcName": "zefa-111",
                "Zone": "ap-guangzhou-7",
                "ZoneId": 100007
            }
        ],
        "RequestId": "3664d030-623c-40fb-bf19-f69a2d58dfe2",
        "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.DescribeResourceTagsFailed Failed to pull resource tags.
    FailedOperation.GetCamRoleFailed Failed to obtain the CAM role.
    FailedOperation.GetCamServerFailed Failed to call the CAM service.
    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.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.
    InternalError.WoodServerError Internal service call exception.
    InvalidParameter Parameter error.
    InvalidParameter.DisplayStrategyNotMatch Display policy error.
    InvalidParameter.InvalidClusterId Invalid parameter: ClusterId.
    InvalidParameter.OrderFieldNotMatch Sorting field error.
    ResourceNotFound.InstanceNotFound The instance cannot be found.
    UnauthorizedOperation.CheckCamAuth No permission to verify account operations.
    UnsupportedOperation.NotInWhiteList This feature is supported by the allowlist.
    前の記事へ: DescribeInstances次の記事へ: InquiryPriceCreateInstance

    ヘルプとサポート

    この記事はお役に立ちましたか？

    フィードバック

    キーワードで検索
      Enter keywords to search documentation