tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstancesList

Last updated: 2024-01-09 10:47:33

    1. API Description

    Domain name for API request: emr.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 No String Common Params. This parameter is not required for this API.
    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 returned results per page. Default value: 10; maximum value: 100.
    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 according to OrderField in ascending or descending order. Valid range:
  • 0: Descending order.
  • 1: Ascending order.
    • Default: 0.
    Filters.N No Array of Filters Custom query

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying Instance Details

    Querying Instance Details

    Input Example

    POST / HTTP/1.1
Host: emr.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": {
        "TotalCnt": 1,
        "InstancesList": [
            {
                "Zone": "xx",
                "IsMultiZoneCluster": true,
                "SubnetName": "xx",
                "Status": 1,
                "VpcId": 1,
                "AlarmInfo": "xx",
                "Tags": [
                    {
                        "TagKey": "xx",
                        "TagValue": "xx"
                    },
                    {
                        "TagKey": "xx",
                        "TagValue": "xx"
                    },
                    {
                        "TagKey": "xx",
                        "TagValue": "xx"
                    }
                ],
                "RegionId": 1,
                "ClusterId": "xx",
                "IsHandsCluster": true,
                "VpcName": "Test",
                "AddTime": "xx",
                "SubnetId": 1,
                "MasterIp": "xx",
                "ProjectId": 1,
                "ZoneId": 1,
                "StatusDesc": "xx",
                "ProductId": 1,
                "UniqVpcId": "xx",
                "ClusterName": "xx",
                "EmrVersion": "xx",
                "IsWoodpeckerCluster": 1,
                "UniqSubnetId": "xx",
                "ChargeType": 1,
                "AppId": 1,
                "ClusterClass": "xx",
                "Id": 1,
                "OutSideSoftInfo": [
                    {
                        "SoftName": "hdfs-2.8.5",
                        "Required": true
                    }
                ]
            }
        ],
        "RequestId": "xx"
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy