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.
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: 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: |
| Asc | No | Integer | Sort by OrderField in ascending or descending order. Valid values: |
| Filters.N | No | Array of Filters | Custom search filter. Examples: |
| 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. |
This example shows you how to query instance details.
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"
}{
"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
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan