查询EMR实例

最近更新时间:2019-09-19 14:57:52

1. 接口描述

接口请求域名: emr.tencentcloudapi.com 。

查询EMR实例

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances
Version String 公共参数,本接口取值:2019-01-03
Region String 公共参数,详见产品支持的 地域列表
DisplayStrategy String 集群展示策略,该字段取值根据所选页面不同输入不同,集群列表页:clusterList,集群监控:monitorManage,云硬件管理:cloudHardwareManage,组件管理页:componentManage
InstanceIds.N Array of String 查询列表, 如果不填写,返回该AppId下所有实例列表
Offset Integer 查询偏移量,默认0
Limit Integer 查询结果限制,默认值10
ProjectId Integer 项目列表,默认值-1
OrderField String 排序字段,当前支持以下排序字段:clusterId、addTime、status
Asc Integer 排序方法,0降序,1升序

3. 输出参数

参数名称 类型 描述
TotalCnt Integer 实例数量
ClusterList Array of ClusterInstancesInfo 集群实例信息列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例详情

输入示例

https://emr.tencentcloudapi.com/?Action=DescribeInstances
&Offset=0
&Limit=10
&ProjectId=0
&OrderField=clusterid
&Asc=0
&DisplayStrategy=clusterList
&InstanceIds.0=emr-p9f700x8
&<公共请求参数>

输出示例

{
  "Response": {
    "ClusterList": [
      {
        "AddTime": "2019-09-16 16:48:01",
        "AlarmInfo": "",
        "AppId": 251008830,
        "ChargeType": 1,
        "ClusterId": "emr-p9f700x8",
        "ClusterName": "beckwu_包年勿删",
        "Config": {
          "ChargeType": 1,
          "ComNodeSize": 0,
          "ComResource": {
            "Cpu": 0,
            "DiskSize": 0,
            "DiskType": "",
            "MemSize": 0,
            "RootSize": 0,
            "Spec": "",
            "SpecName": "",
            "StorageType": 0
          },
          "CoreNodeSize": 2,
          "CoreResource": {
            "Cpu": 2,
            "DiskSize": 100,
            "DiskType": "CLOUD_BASIC",
            "MemSize": 8192,
            "RootSize": 0,
            "Spec": "CVM.S2",
            "SpecName": "EMR标准型S2",
            "StorageType": 2
          },
          "MasterNodeSize": 1,
          "MasterResource": {
            "Cpu": 2,
            "DiskSize": 100,
            "DiskType": "CLOUD_BASIC",
            "MemSize": 8192,
            "RootSize": 0,
            "Spec": "CVM.S2",
            "SpecName": "EMR标准型S2",
            "StorageType": 2
          },
          "OnCos": false,
          "SoftInfo": [
            "zookeeper-3.4.9",
            "hadoop-3.1.2",
            "knox-1.2.0",
            "sys-1.0"
          ],
          "TaskNodeSize": 1,
          "TaskResource": {
            "Cpu": 2,
            "DiskSize": 100,
            "DiskType": "CLOUD_BASIC",
            "MemSize": 8192,
            "RootSize": 0,
            "Spec": "CVM.S2",
            "SpecName": "EMR标准型S2",
            "StorageType": 2
          }
        },
        "EmrVersion": "EMR-V3.0.0",
        "Ftitle": "集群运行中",
        "Id": 19541,
        "IsTradeCluster": 0,
        "MasterIp": "--",
        "ProjectId": 0,
        "RegionId": 1,
        "ResourceOrderId": 0,
        "RunTime": "0天2小时48分钟55秒",
        "Status": 2,
        "SubnetId": 1230738,
        "TradeVersion": 1,
        "Uin": "1875765535",
        "VpcId": 78518,
        "ZoneId": 100002
      }
    ],
    "RequestId": "4f337873-6fea-4338-9715-24f539b60949",
    "TotalCnt": 1
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.DisplayStrategyNotMatch 展示策略错误。
InvalidParameter.InvalidClusterId 无效参数,ClusterId。
InvalidParameter.OrderFieldNotMatch 排序字段错误。
ResourceNotFound.ClusterNotFound 无法找到该实例。
ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。