EMR 开发指南

查询EMR实例

最近更新时间:2020-09-02 08:08:40

1. 接口描述

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

查询EMR实例

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:emr.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
DisplayStrategy String 集群筛选策略。取值范围:
  • clusterList:表示查询除了已销毁集群之外的集群列表。
  • monitorManage:表示查询除了已销毁、创建中以及创建失败的集群之外的集群列表。
  • cloudHardwareManage/componentManage:目前这两个取值为预留取值,暂时和monitorManage表示同样的含义。
  • InstanceIds.N Array of String 按照一个或者多个实例ID查询。实例ID形如: emr-xxxxxxxx 。(此参数的具体格式可参考API简介的 Ids.N 一节)。如果不填写实例ID,返回该APPID下所有实例列表。
    Offset Integer 页编号,默认值为0,表示第一页。
    Limit Integer 每页返回数量,默认值为10,最大值为100。
    ProjectId Integer 建议必填-1,表示拉取所有项目下的集群。
    不填默认值为0,表示拉取默认项目下的集群。
    实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。
    OrderField String 排序字段。取值范围:
  • clusterId:表示按照实例ID排序。
  • addTime:表示按照实例创建时间排序。
  • status:表示按照实例的状态码排序。
  • Asc Integer 按照OrderField升序或者降序进行排序。取值范围:
  • 0:表示降序。
  • 1:表示升序。
  • 默认值为0。

    3. 输出参数

    参数名称 类型 描述
    TotalCnt Integer 符合条件的实例总数。
    ClusterList Array of ClusterInstancesInfo EMR实例详细信息列表。
    注意:此字段可能返回 null,表示取不到有效值。
    TagKeys Array of String 实例关联的标签键列表。
    注意:此字段可能返回 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 内部错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.CdbCgwError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    InternalError.ConfigCgwError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    InternalError.KmsError 内部服务调用异常。
    InternalError.ProjectCgwError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    InternalError.TagError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InternalError.VpcCgwError 内部服务调用异常。
    InternalError.VpcError 内部服务调用异常。
    InternalError.WoodServerError Woodpecker server调用出错。
    InvalidParameter 参数错误。
    InvalidParameter.DisplayStrategyNotMatch 展示策略错误。
    InvalidParameter.InvalidClusterId 无效参数,ClusterId。
    InvalidParameter.OrderFieldNotMatch 排序字段错误。
    ResourceNotFound.ClusterNotFound 无法找到该实例。
    ResourceNotFound.HardwareInfoNotFound 无法找到硬件信息。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    目录