解决方案
API Explorer
绿洲T300-Z 环境传感器Restful API接口文档
3.1.1 获取集群名称
获取当前manager管理的所有集群名称。

接口URI

/api/v1/clusters

访问方法
HTTP 方法
GET
参数
返回结果
消息体
元素含义

Links各子元素

href

请求链接。

items

返回数据。

Href:集群详情访问链接。

Clusters:集群详情信息。

应用举例

请求

请求

3.1.2 获取集群运行状态
获取集群运行状态。
接口URI
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

返回结果
消息体
元素含义

Links各子元素

href

请求链接。

items

返回数据。

Href:集群详情访问链接。

Clusters:集群详情信息。

provisioning_state:集群状态,INSTALLED代表已安装完成。

应用举例

请求

请求

3.1.3 获取集群请求列表
获取当前集群中的请求列表。
接口URI
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

Page_size

最大请求条数。

String类型,可选。

返回结果
消息体
元素含义

Links各子元素

href

请求链接。

itemTotal

返回数据条数。

Items

返回数据。

Href:请求详情访问链接。

Requests:操作请求详情信息。

应用举例

请求

请求

元素含义

Links各子元素

href

请求链接。

Item—Total

返回数据。

Href:集群详情访问链接。

Clusters:集群详情信息。

items

返回数据。

Href:集群详情访问链接。

Clusters:集群详情信息。

3.1.4 获取集群健康状态
获取当前集群的健康状态信息。
接口URI
访问方法
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
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

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

返回结果
消息体
元素含义

Links各子元素

Clusters

集群信息。

默认都会带上此信息。

metrics

指标信息。

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

应用举例

请求

请求

3.1.1 获取集群主机列表
获取当前集群类所有主机信息。
接口URI
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

Page_size

最大请求条数。

String类型,可选。

minimal_response

是否最小返回。

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

from

记录开始参数。

String类型,可选。

sortBy

排序字段。

String类型,可选。

返回结果
消息体
元素含义

Links各子元素

itemTotal

主机总数。

items

主机详细数据。

Hosts:主机概要信息。

alerts_summary:主机告警信息。

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

应用举例

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

3.1.2 启动/停止主机上所有组件
操作主机上所有组件。
接口URI

访问方法

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
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

Alert/host_name

筛选条件。

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

返回结果
消息体
元素含义

Links各子元素

href

请求链接。

Items

返回数据。

Href:告警详情访问链接。

Alert:告警详情信息。

State:告警状态,OK代表没有告警。

应用举例

请求

请求

3.1.4 开启/关闭主机维护模式
开启维护模式。
接口URI

访问方法

HTTP方法

PUT

参数

query

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

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

Body

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

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

返回结果

应用举例

请求

请求

3.1.1 获取集群服务列表
获取当前集群内安装的所有服务信息。
接口URI
访问方法
HTTP 方法
GET
参数

Field

请求字段列表。

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

返回结果
消息体
元素含义

Links各子元素

Href

请求链接。

Versions

Stack版本信息。

Services

服务信息列表。

StackServices:服务信息。

Service_name:服务名称。

应用举例

请求

请求

3.1.2 启动/停止服务所有组件
操作服务所有组件启动/停止。
接口URI

访问方法

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代表请求被接受。

应用举例

请求

请求

版权所有 2003-2022 新华三技术有限公司.保留一切权利.浙ICP备09064986号-1浙公网安备 33010802004416