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
ドキュメントElastic MapReduceAPI DocumentationCluster Resource Management APIsDescribeInstancesList

DescribeInstancesList

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-11-13 20:49:16

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 excluding terminated ones.
  • monitorManage: Queries the list of clusters excluding those terminated, under creation and not successfully created.
  • cloudHardwareManage/componentManage: Two reserved values, which have the same implications as those of monitorManage.
    		•
    Offset No Integer Page number. Default value: 0, indicating the first page.
    Limit No Integer Number of records to be returned per page. The default value is 100, and the maximum value is 100.
    If both limit and offset are 0, all records will be queried.
    OrderField No String Sorting field. Valid values:
  • clusterId: Sorting by instance ID.
  • addTime: Sorting by instance creation time.
  • status: Sorting by instance status code.
    		•
    Asc No Integer Sort 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 filter. Examples:
  • instance of filtering by ClusterId: [{"Name":"ClusterId","Values":["emr-xxxxxxxx"]}]
  • instance of filtering by clusterName: [{"Name": "ClusterName","Values": ["cluster_name"]}]
  • instance of filtering by ClusterStatus: [{"Name": "ClusterStatus","Values": ["2"]}]
    • .

    3. Output Parameters

    Parameter Name Type Description
    TotalCnt Integer Number of eligible instances.
    InstancesList Array of EmrListInstance Cluster instance 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 and 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 fetch resource tag.
    FailedOperation.GetCamRoleFailed Failed to query the CAM role.
    FailedOperation.GetCamServerFailed Failed to call the CAM service.
    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.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.
    InternalError.WoodServerError An error occurred while calling another service API.
    InvalidParameter Invalid parameter.
    InvalidParameter.DisplayStrategyNotMatch Incorrect display policy.
    InvalidParameter.InvalidClusterId Invalid parameter: ClusterId.
    InvalidParameter.OrderFieldNotMatch Invalid sorting field.
    ResourceNotFound.InstanceNotFound The instance was not found.
    UnauthorizedOperation.CheckCamAuth Unauthorized operation.
    UnsupportedOperation.NotInWhiteList This function is included in the allowlist.
    前の記事へ: DescribeInstances次の記事へ: InquiryPriceCreateInstance

    ヘルプとサポート

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

    フィードバック