绿洲T300-Z 环境传感器Restful API接口文档-新华三开发者中心-H3C

3.1.1 获取集群名称

获取当前manager管理的所有集群名称。

接口URI

/api/v1/clusters

访问方法

HTTP 方法

GET

参数

返回结果

消息体

元素含义

Links各子元素

href

请求链接。

items

返回数据。

Href：集群详情访问链接。

Clusters：集群详情信息。

应用举例

请求

3.1.2 获取集群运行状态

获取集群运行状态。

接口URI

/api/v1/clusters?fields=Clusters/provisioning_state

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，可选，根据输入的不同可以实现很多功能。

返回结果

消息体

元素含义

Links各子元素

href

请求链接。

items

返回数据。

Href：集群详情访问链接。

Clusters：集群详情信息。

provisioning_state：集群状态，INSTALLED代表已安装完成。

应用举例

请求

3.1.3 获取集群请求列表

获取当前集群中的请求列表。

接口URI

/api/v1/clusters/{cluster_name}/requests?page_size=10&fields=Requests

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，必选，根据输入的不同可以实现很多功能。

Page_size

最大请求条数。

String类型，可选。

返回结果

消息体

{
  "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests?page_size=10&fields=Requests&_=1526028680262",
  "itemTotal": "7",
  "items": [
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/4",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 62,
        "create_time": 1522314533400,
        "end_time": 1522314704448,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 4,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "安装服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522314533457,
        "task_count": 62,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    }
  ]
}

元素含义

Links各子元素
href	请求链接。
itemTotal	返回数据条数。
Items	返回数据。 Href：请求详情访问链接。 Requests：操作请求详情信息。

应用举例

请求

{
  "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests?page_size=10&fields=Requests&_=1526028680262",
  "itemTotal": "7",
  "items": [
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/4",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 62,
        "create_time": 1522314533400,
        "end_time": 1522314704448,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 4,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "安装服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522314533457,
        "task_count": 62,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/5",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 34,
        "create_time": 1522314705811,
        "end_time": 1522314898951,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 5,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "启动服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522314705845,
        "task_count": 34,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/6",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 13,
        "create_time": 1522315464105,
        "end_time": 1522315537084,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 6,
        "inputs": "{}",
        "operation_level": "SERVICE",
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "重启使用过期配置的HIVE上的所有组件",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [
          {
            "service_name": "HIVE",
            "component_name": "HCAT",
            "hosts": [
              "node1.hde.h3c.com",
              "node2.hde.h3c.com",
              "node3.hde.h3c.com",
              "node4.hde.h3c.com",
              "node5.hde.h3c.com"
            ]
          },
          {
            "service_name": "HIVE",
            "component_name": "WEBHCAT_SERVER",
            "hosts": [
              "node2.hde.h3c.com"
            ]
          },
          {
            "service_name": "HIVE",
            "component_name": "HIVE_METASTORE",
            "hosts": [
              "node2.hde.h3c.com"
            ]
          },
          {
            "service_name": "HIVE",
            "component_name": "HIVE_CLIENT",
            "hosts": [
              "node1.hde.h3c.com",
              "node2.hde.h3c.com",
              "node3.hde.h3c.com",
              "node4.hde.h3c.com",
              "node5.hde.h3c.com"
            ]
          },
          {
            "service_name": "HIVE",
            "component_name": "HIVE_SERVER",
            "hosts": [
              "node2.hde.h3c.com"
            ]
          }
        ],
        "start_time": 1522315464130,
        "task_count": 13,
        "timed_out_task_count": 0,
        "type": "COMMAND"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/7",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 3,
        "create_time": 1522316080834,
        "end_time": 1522316150838,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 7,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "安装服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522316080843,
        "task_count": 3,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/8",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 3,
        "create_time": 1522316151829,
        "end_time": 1522316166250,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 8,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "启动新增的服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522316151839,
        "task_count": 3,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/9",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 1,
        "create_time": 1522316344774,
        "end_time": 1522316425590,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 9,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "安装服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522316344781,
        "task_count": 1,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/requests/10",
      "Requests": {
        "aborted_task_count": 0,
        "cluster_name": "cluster",
        "completed_task_count": 1,
        "create_time": 1522316427894,
        "end_time": 1522316442982,
        "exclusive": false,
        "failed_task_count": 0,
        "id": 10,
        "inputs": null,
        "operation_level": null,
        "progress_percent": 100.0,
        "queued_task_count": 0,
        "request_context": "启动新增的服务",
        "request_schedule": null,
        "request_status": "COMPLETED",
        "resource_filters": [],
        "start_time": 1522316427900,
        "task_count": 1,
        "timed_out_task_count": 0,
        "type": "INTERNAL_REQUEST"
      }
    }
  ]
}

元素含义

Links各子元素
href	请求链接。
Item—Total	返回数据。 Href：集群详情访问链接。 Clusters：集群详情信息。
items	返回数据。 Href：集群详情访问链接。 Clusters：集群详情信息。

3.1.4 获取集群健康状态

获取当前集群的健康状态信息。

接口URI

/api/v1/clusters/{cluster_name}?fields=Clusters/health_report,Clusters/total_hosts,alerts_summary_hosts&minimal_response=true

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，必选，根据具体需求选择，Clusters/health_report,Clusters/total_hosts,alerts_summary_hosts代表健康状态报告，主机总数，以及告警概要。

minimal_response

是否最小返回。

String类型，可选，为true代表只返回请求的数据，省略掉很多冗余数据。

返回结果

消息体

元素含义

Links各子元素

Clusters

集群信息。

Clusters：健康报告。

Total_hosts：主机总数。

alerts_summary_hosts

告警汇总信息。

应用举例

请求

3.1.5 获取集群指标信息

获取当前集群的核心指标信息。

接口URI

/api/v1/clusters/cluster?fields=metrics/cpu/Idle._avg[1525996354,1526000134,15],metrics/memory/Total._avg[1525996354,1526000134,15],metrics/memory/Use._avg[1525996354,1526000134,15],metrics/network/Out._avg[1525996354,1526000134,15]

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，必选，根据具体需求选择。

metrics/cpu/Idle._avg[1525996354,1526000134,15]代表获取cpu指标信息，后面的中括号内数字分别代表起始时间，结束时间，取点间隔。

返回结果

消息体

元素含义

Links各子元素

Clusters

集群信息。

默认都会带上此信息。

metrics

指标信息。

Cpu：cpu使用情况，每组数据含义是cpu占用率，时间戳。

应用举例

请求

3.1.1 获取集群主机列表

获取当前集群类所有主机信息。

接口URI

/api/v1/clusters/cluster/hosts?fields=Hosts/rack_info,Hosts/rack_id,Hosts/rack_position,Hosts/host_name,Hosts/maintenance_state,Hosts/public_host_name,Hosts/cpu_count,Hosts/ph_cpu_count,alerts_summary,Hosts/host_status,Hosts/last_heartbeat_time,Hosts/ip,host_components/HostRoles/state,host_components/HostRoles/maintenance_state,host_components/HostRoles/stale_configs,host_components/HostRoles/service_name,host_components/HostRoles/desired_admin_state,Hosts/total_mem,stack_versions/HostStackVersions,stack_versions/repository_versions/RepositoryVersions/repository_version,stack_versions/repository_versions/RepositoryVersions/id,stack_versions/repository_versions/RepositoryVersions/display_name&minimal_response=true&page_size=10&from=0&sortBy=Hosts/host_name.asc

访问方法

HTTP 方法

GET

参数

Field	请求字段列表。 String类型，可选，根据输入的不同可以实现很多功能。
Page_size	最大请求条数。 String类型，可选。
minimal_response	是否最小返回。 String类型，可选，为true代表只返回请求的数据，省略掉很多冗余数据。
from	记录开始参数。 String类型，可选。
sortBy	排序字段。 String类型，可选。

返回结果

消息体

{
  "itemTotal": "5",
  "items": [
    {
      "Hosts": {
        "cpu_count": 4,
        "host_name": "node1.hde.h3c.com",
        "host_status": "HEALTHY",
        "ip": "101.8.54.191",
        "last_heartbeat_time": 1526003424481,
        "maintenance_state": "OFF",
        "ph_cpu_count": 2,
        "public_host_name": "node1.hde.h3c.com",
        "rack_id": 1,
        "rack_info": "/default-rack",
        "rack_position": 1,
        "total_mem": 33030516
      },
      "alerts_summary": {
        "CRITICAL": 1,
        "MAINTENANCE": 0,
        "OK": 23,
        "UNKNOWN": 0,
        "WARNING": 0
      },
      "stack_versions": [
        {
          "HostStackVersions": {
            "cluster_name": "cluster",
            "host_name": "node1.hde.h3c.com",
            "id": 1,
            "repository_version": 1,
            "stack": "HDP",
            "state": "CURRENT",
            "version": "2.3"
          },
          "repository_versions": [
            {
              "RepositoryVersions": {
                "display_name": "HDP-2.3.4.0-3485",
                "id": 1,
                "repository_version": "2.3.4.0-3485"
              }
            }
          ]
        }
      ],
      "host_components": [
        {
          "HostRoles": {
            "component_name": "DATANODE",
            "desired_admin_state": "INSERVICE",
            "maintenance_state": "OFF",
            "service_name": "HDFS",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "DI_Executor",
            "desired_admin_state": "INSERVICE",
            "maintenance_state": "OFF",
            "service_name": "DI",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "DSG_NODE",
            "maintenance_state": "OFF",
            "service_name": "DSG",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "HCAT",
            "maintenance_state": "OFF",
            "service_name": "HIVE",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "HDFS_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "HDFS",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "HIVE_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "HIVE",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "MAPREDUCE2_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "MAPREDUCE2",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "METRICS_MONITOR",
            "desired_admin_state": "INSERVICE",
            "maintenance_state": "OFF",
            "service_name": "AMBARI_METRICS",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "NAMENODE",
            "maintenance_state": "OFF",
            "service_name": "HDFS",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "NODEMANAGER",
            "desired_admin_state": "INSERVICE",
            "maintenance_state": "OFF",
            "service_name": "YARN",
            "stale_configs": false,
            "state": "STARTED"
          }
        },
        {
          "HostRoles": {
            "component_name": "TEZ_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "TEZ",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "YARN_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "YARN",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "ZOOKEEPER_CLIENT",
            "maintenance_state": "OFF",
            "service_name": "ZOOKEEPER",
            "stale_configs": false,
            "state": "INSTALLED"
          }
        },
        {
          "HostRoles": {
            "component_name": "ZOOKEEPER_SERVER",
            "maintenance_state": "OFF",
            "service_name": "ZOOKEEPER",
            "stale_configs": false,
            "state": "STARTED"
          }
        }
      ]
    }
  ]
}

元素含义

Links各子元素

itemTotal

主机总数。

items

主机详细数据。

Hosts：主机概要信息。

alerts_summary：主机告警信息。

host_components：主机上安装的组件信息。

应用举例

数据太多，请参考上面描述。

3.1.2 启动/停止主机上所有组件

操作主机上所有组件。

接口URI

api/v1/clusters/cluster/hosts/{host_name}/host_components

访问方法

HTTP方法

PUT

参数

operation_level

操作级别信息，包含级别，集群名，主机名信息。

比如 {"level":"HOST","cluster_name":"cluster","host_names":"node1.hde.h3c.com"}

query

操作过滤条件，比如操作哪些组件。

比如"HostRoles/component_name.in(DATANODE,DI_Executor,DSG_NODE,METRICS_MONITOR,NAMENODE,NODEMANAGER,ZOOKEEPER_SERVER)"}

Body

操作指令信息，比如停止主机为state变为INSTALLED。

比如 {"HostRoles":{"state":"INSTALLED"}}

返回结果

消息体

元素含义

Links各子元素

href

操作请求详情链接。

Requests

请求概要数据。

Id：request id。

Status：请求状态，accepted代表请求被接受。

应用举例

请求

3.1.3 获取主机的告警信息列表

获取当前主机上的告警信息列表。

接口URI

/api/v1/clusters/{cluster_name}/alerts?fields=*&Alert/host_name={host_name}

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，必选，*号代表全部告警信息。

Alert/host_name

筛选条件。

String类型，必选，需要查询主机的。

返回结果

消息体

{
  "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts?fields=*&Alert/host_name=node1.hde.h3c.com&_=1526112737594",
  "items": [
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/26",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 46,
        "definition_name": "ambari_agent_disk_usage",
        "host_name": "node1.hde.h3c.com",
        "id": 26,
        "instance": null,
        "label": "DataEngine Agent Disk Usage",
        "latest_timestamp": 1526084179592,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314602660,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "Capacity Used: [35.01%, 73.9 GB], Capacity Total: [211.0 GB], path=/usr/hdp"
      }
    }
  ]
}

元素含义

Links各子元素

href

请求链接。

Items

返回数据。

Href：告警详情访问链接。

Alert：告警详情信息。

State：告警状态，OK代表没有告警。

应用举例

请求

{
  "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts?fields=*&Alert/host_name=node1.hde.h3c.com&_=1526112737594",
  "items": [
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/26",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 46,
        "definition_name": "ambari_agent_disk_usage",
        "host_name": "node1.hde.h3c.com",
        "id": 26,
        "instance": null,
        "label": "DataEngine Agent Disk Usage",
        "latest_timestamp": 1526084179592,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314602660,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "Capacity Used: [35.01%, 73.9 GB], Capacity Total: [211.0 GB], path=/usr/hdp"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/27",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 48,
        "definition_name": "agent_partition_usage",
        "host_name": "node1.hde.h3c.com",
        "id": 27,
        "instance": null,
        "label": "DataEngine Agent partition Usage",
        "latest_timestamp": 1526084179584,
        "maintenance_state": "OFF",
        "original_timestamp": 1523520027357,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "Capacity Used: [35.01%, 73.9 GB], Capacity Total: [211.0 GB], path=/;"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/28",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 45,
        "definition_name": "agent_ntp_status",
        "host_name": "node1.hde.h3c.com",
        "id": 28,
        "instance": null,
        "label": "DataEngine Agent NTP Service Status",
        "latest_timestamp": 1526084179612,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314602763,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "NTP status is ok.Time offset is 0.0000 ms."
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/29",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 47,
        "definition_name": "agent_disk_status",
        "host_name": "node1.hde.h3c.com",
        "id": 29,
        "instance": null,
        "label": "DataEngine Agent Disk Status",
        "latest_timestamp": 1526084179585,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314602654,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "['Disk state is ok.']"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/30",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_AGENT",
        "definition_id": 44,
        "definition_name": "agent_log_usage",
        "host_name": "node1.hde.h3c.com",
        "id": 30,
        "instance": null,
        "label": "DataEngine Agent Log Usage",
        "latest_timestamp": 1526084179592,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314602661,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "Capacity Used: [35.01%, 73.9 GB], Capacity Total: [211.0 GB], path=/var/log"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/78",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "AMBARI_SERVER",
        "definition_id": 49,
        "definition_name": "ambari_server_agent_heartbeat",
        "host_name": "node1.hde.h3c.com",
        "id": 78,
        "instance": null,
        "label": "DataEngine Agent Heartbeat",
        "latest_timestamp": 1526084134737,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314675184,
        "scope": "HOST",
        "service_name": "AMBARI",
        "state": "OK",
        "text": "node1.hde.h3c.com is healthy"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/38",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "METRICS_MONITOR",
        "definition_id": 41,
        "definition_name": "ams_metrics_monitor_process",
        "host_name": "node1.hde.h3c.com",
        "id": 38,
        "instance": null,
        "label": "Metrics MonitorçŠ¶æ€",
        "latest_timestamp": 1526084179593,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083399622,
        "scope": "ANY",
        "service_name": "AMBARI_METRICS",
        "state": "CRITICAL",
        "text": "Ambari Monitor is NOT running on node1.hde.h3c.com"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/21",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 17,
        "definition_name": "namenode_last_checkpoint",
        "host_name": "node1.hde.h3c.com",
        "id": 21,
        "instance": null,
        "label": "NameNodeä¸Šä¸€æ¬¡Checkpoint",
        "latest_timestamp": 1526084179564,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459568,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "<urlopen error [Errno 111] Connection refused>"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/22",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 18,
        "definition_name": "namenode_webui",
        "host_name": "node1.hde.h3c.com",
        "id": 22,
        "instance": null,
        "label": "NameNode Web UI",
        "latest_timestamp": 1526084179588,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459606,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "CRITICAL",
        "text": "Connection failed to http://node1.hde.h3c.com:50070 (<urlopen error [Errno 111] Connection refused>)"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/23",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 7,
        "definition_name": "datanode_health_summary",
        "host_name": "node1.hde.h3c.com",
        "id": 23,
        "instance": null,
        "label": "DataNodeå¥åº·æ¦‚è¦",
        "latest_timestamp": 1526084179552,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459556,
        "scope": "SERVICE",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][datanode_health_summary] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/24",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 6,
        "definition_name": "upgrade_finalized_state",
        "host_name": "node1.hde.h3c.com",
        "id": 24,
        "instance": null,
        "label": "HDFSå‡çº§æœ€ç»ˆçŠ¶æ€",
        "latest_timestamp": 1526084179545,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459554,
        "scope": "SERVICE",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "<urlopen error [Errno 111] Connection refused>"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/25",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 11,
        "definition_name": "namenode_directory_status",
        "host_name": "node1.hde.h3c.com",
        "id": 25,
        "instance": null,
        "label": "NameNodeç›®å½•çŠ¶æ€",
        "latest_timestamp": 1526084179553,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459563,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_directory_status] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/31",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 4,
        "definition_name": "namenode_hdfs_pending_deletion_blocks",
        "host_name": "node1.hde.h3c.com",
        "id": 31,
        "instance": null,
        "label": "HDFSç‰å¾…åˆé™¤çš„å—æ•°",
        "latest_timestamp": 1526084179542,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459552,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_hdfs_pending_deletion_blocks] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/32",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 14,
        "definition_name": "namenode_hdfs_blocks_health",
        "host_name": "node1.hde.h3c.com",
        "id": 32,
        "instance": null,
        "label": "NameNodeæ•°æ®å—å¥åº·é—®é¢˜",
        "latest_timestamp": 1526084179558,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459596,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_hdfs_blocks_health] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/33",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 15,
        "definition_name": "namenode_hdfs_capacity_utilization",
        "host_name": "node1.hde.h3c.com",
        "id": 33,
        "instance": null,
        "label": "HDFSå®¹é‡ä½¿ç”¨çŽ‡",
        "latest_timestamp": 1526084179564,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459580,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_hdfs_capacity_utilization] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/34",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 16,
        "definition_name": "namenode_rpc_latency",
        "host_name": "node1.hde.h3c.com",
        "id": 34,
        "instance": null,
        "label": "NameNode RPCå»¶è¿Ÿ",
        "latest_timestamp": 1526084179563,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459574,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_rpc_latency] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/36",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "DATANODE",
        "definition_id": 12,
        "definition_name": "datanode_process",
        "host_name": "node1.hde.h3c.com",
        "id": 36,
        "instance": null,
        "label": "DataNodeè¿›ç¨‹",
        "latest_timestamp": 1526084179586,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459573,
        "scope": "HOST",
        "service_name": "HDFS",
        "state": "CRITICAL",
        "text": "Connection failed: [Errno 111] Connection refused to 0.0.0.0:50010"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/37",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "DATANODE",
        "definition_id": 19,
        "definition_name": "datanode_webui",
        "host_name": "node1.hde.h3c.com",
        "id": 37,
        "instance": null,
        "label": "DataNode Web UI",
        "latest_timestamp": 1526084179586,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459604,
        "scope": "HOST",
        "service_name": "HDFS",
        "state": "CRITICAL",
        "text": "Connection failed to http://node1.hde.h3c.com:50075 (<urlopen error [Errno 111] Connection refused>)"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/88",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "DATANODE",
        "definition_id": 9,
        "definition_name": "datanode_unmounted_data_dir",
        "host_name": "node1.hde.h3c.com",
        "id": 88,
        "instance": null,
        "label": "DataNodeæœªæŒ‚è½½çš„æ•°æ®ç›®å½•",
        "latest_timestamp": 1526084179558,
        "maintenance_state": "OFF",
        "original_timestamp": 1522314728154,
        "scope": "HOST",
        "service_name": "HDFS",
        "state": "OK",
        "text": "Data dir(s) are fine, /hadoop/hdfs/data ."
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/89",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "DATANODE",
        "definition_id": 20,
        "definition_name": "datanode_storage",
        "host_name": "node1.hde.h3c.com",
        "id": 89,
        "instance": null,
        "label": "DataNodeå˜å‚¨",
        "latest_timestamp": 1526084179568,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459583,
        "scope": "HOST",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][datanode_storage] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/92",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NAMENODE",
        "definition_id": 1,
        "definition_name": "namenode_cpu",
        "host_name": "node1.hde.h3c.com",
        "id": 92,
        "instance": null,
        "label": "NameNodeä¸»æœºCPUä½¿ç”¨çŽ‡",
        "latest_timestamp": 1526084179541,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083579539,
        "scope": "ANY",
        "service_name": "HDFS",
        "state": "UNKNOWN",
        "text": "[Alert][namenode_cpu] Unable to extract JSON from JMX response"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/39",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NODEMANAGER",
        "definition_id": 35,
        "definition_name": "yarn_nodemanager_webui",
        "host_name": "node1.hde.h3c.com",
        "id": 39,
        "instance": null,
        "label": "NodeManager Web UI",
        "latest_timestamp": 1526084179590,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083399607,
        "scope": "HOST",
        "service_name": "YARN",
        "state": "CRITICAL",
        "text": "Connection failed to http://node1.hde.h3c.com:8042 (<urlopen error [Errno 111] Connection refused>)"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/40",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "NODEMANAGER",
        "definition_id": 31,
        "definition_name": "yarn_nodemanager_health",
        "host_name": "node1.hde.h3c.com",
        "id": 40,
        "instance": null,
        "label": "NodeManagerå¥åº·é—®é¢˜",
        "latest_timestamp": 1526084179587,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083399600,
        "scope": "HOST",
        "service_name": "YARN",
        "state": "CRITICAL",
        "text": "Connection failed to http://node1.hde.h3c.com:8042/ws/v1/node/info (<urlopen error [Errno 111] Connection refused>)"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/clusters/cluster/alerts/35",
      "Alert": {
        "cluster_name": "cluster",
        "component_name": "ZOOKEEPER_SERVER",
        "definition_id": 40,
        "definition_name": "zookeeper_server_process",
        "host_name": "node1.hde.h3c.com",
        "id": 35,
        "instance": null,
        "label": "ZooKeeper Serverè¿›ç¨‹",
        "latest_timestamp": 1526084179590,
        "maintenance_state": "OFF",
        "original_timestamp": 1526083459604,
        "scope": "ANY",
        "service_name": "ZOOKEEPER",
        "state": "CRITICAL",
        "text": "Connection failed: [Errno 111] Connection refused to node1.hde.h3c.com:2181"
      }
    }
  ]
}

3.1.4 开启/关闭主机维护模式

开启维护模式。

接口URI

/api/v1/clusters/cluster/hosts

访问方法

HTTP方法

PUT

参数

query

操作过滤条件，比如操作哪些组件。

比如 "Hosts/host_name.in(node1.hde.h3c.com)"

Body

操作指令信息，比如开启维护模式为设置maintenance_state为on。

比如 {"Hosts":{"maintenance_state":"ON"}}

返回结果

无

应用举例

请求

3.1.1 获取集群服务列表

获取当前集群内安装的所有服务信息。

接口URI

/api/v1/stacks/HDP/versions/2.3/services?fields=services

访问方法

HTTP 方法

GET

参数

Field

请求字段列表。

String类型，可选，根据输入的不同可以实现很多功能。

返回结果

消息体

元素含义

Links各子元素
Href	请求链接。
Versions	Stack版本信息。
Services	服务信息列表。 StackServices：服务信息。 Service_name：服务名称。

应用举例

请求

{
  "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3?fields=services",
  "Versions": {
    "stack_name": "HDP",
    "stack_version": "2.3"
  },
  "services": [
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/AMBARI_METRICS",
      "StackServices": {
        "service_name": "AMBARI_METRICS",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/BDOC",
      "StackServices": {
        "service_name": "BDOC",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/DATAFRAME",
      "StackServices": {
        "service_name": "DATAFRAME",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/DI",
      "StackServices": {
        "service_name": "DI",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/DSG",
      "StackServices": {
        "service_name": "DSG",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/DVE",
      "StackServices": {
        "service_name": "DVE",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/ELASTICSEARCH",
      "StackServices": {
        "service_name": "ELASTICSEARCH",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/ELASTICSEARCH5",
      "StackServices": {
        "service_name": "ELASTICSEARCH5",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/FLUME",
      "StackServices": {
        "service_name": "FLUME",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HBASE",
      "StackServices": {
        "service_name": "HBASE",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HBASE_INDEXER",
      "StackServices": {
        "service_name": "HBASE_INDEXER",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HDFS",
      "StackServices": {
        "service_name": "HDFS",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HIVE",
      "StackServices": {
        "service_name": "HIVE",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HIVE2",
      "StackServices": {
        "service_name": "HIVE2",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/HUE",
      "StackServices": {
        "service_name": "HUE",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/INFRA",
      "StackServices": {
        "service_name": "INFRA",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/KAFKA",
      "StackServices": {
        "service_name": "KAFKA",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/KERBEROS",
      "StackServices": {
        "service_name": "KERBEROS",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/LOGMANAGER",
      "StackServices": {
        "service_name": "LOGMANAGER",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/MAPREDUCE2",
      "StackServices": {
        "service_name": "MAPREDUCE2",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/MPP",
      "StackServices": {
        "service_name": "MPP",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/OOZIE",
      "StackServices": {
        "service_name": "OOZIE",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/POSTGRESQL",
      "StackServices": {
        "service_name": "POSTGRESQL",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/REDIS",
      "StackServices": {
        "service_name": "REDIS",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/SOLR",
      "StackServices": {
        "service_name": "SOLR",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/SPARK",
      "StackServices": {
        "service_name": "SPARK",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/SPARK2",
      "StackServices": {
        "service_name": "SPARK2",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/SQOOP",
      "StackServices": {
        "service_name": "SQOOP",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/STORM",
      "StackServices": {
        "service_name": "STORM",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/TEZ",
      "StackServices": {
        "service_name": "TEZ",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/YARN",
      "StackServices": {
        "service_name": "YARN",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    },
    {
      "href": "https://node1.hde.h3c.com:8443/api/v1/stacks/HDP/versions/2.3/services/ZOOKEEPER",
      "StackServices": {
        "service_name": "ZOOKEEPER",
        "stack_name": "HDP",
        "stack_version": "2.3"
      }
    }
  ]
}

3.1.2 启动/停止服务所有组件

操作服务所有组件启动/停止。

接口URI

/api/v1/clusters/{cluster_name}/services/{service_name}

访问方法

HTTP方法

PUT

参数

operation_level

操作级别信息，包含级别，集群名，服务名信息。

比如{"level":"SERVICE","cluster_name":"cluster","service_name":"AMBARI_METRICS"}

context

操作上下文，主要描述操作代号。

比如_PARSE_.STOP.AMBARI_METRICS

Body

操作指令信息，比如停止主机为state变为INSTALLED。

比如 {"state":"INSTALLED"}

返回结果

消息体

元素含义

Links各子元素

href

操作请求详情链接。

Requests

请求概要数据。

Id：request id。

Status：请求状态，accepted代表请求被接受。

应用举例

请求