跳到主要内容
版本：3.0.0

视图 API

本节介绍 View REST API 的基本用法。有关详细的用法信息和示例，请参阅 https://github.com/apache/ambari/blob/trunk/ambari-views/docs/index.md。

获取已部署 View 的列表​

  1. 获取所有已部署 View 的列表。
GET /api/v1/views
 
200 - OK
  1. 获取 View 列表后，可以深入查看某个 View，并查看可用的版本。
GET /api/v1/views/FILES
 
200 - OK
  1. 还可以再深入一层，查看该 View 特定版本的更多信息（例如参数和归档名称），以及该 View 版本的所有实例列表。
GET /api/v1/views/FILES/versions/0.1.0
 
200 - OK

创建 View 实例：Files View​

以下示例展示如何创建 Files View 的实例：名称为 FILES、版本为 0.1.0，实例名称为 "MyFiles"。

  1. 创建 View 实例。
POST /api/v1/views/FILES/versions/0.1.0/instances/MyFiles
 
[ {
"ViewInstanceInfo" : {
    "properties" : {
      "dataworker.defaultFs" : "webhdfs://your.namenode.host:50070"
    }
  }
} ]
 
201 - CREATED
信息

创建 View 实例时，请务必提供所有必需的 View 实例属性，否则将收到 500 响应，并附带说明所需属性的消息。

  1. 重启 Ambari Server，以加载 View 实例和 UI 资源。
ambari-server restart
  1. 确认新创建的 View 实例可用。
GET /api/v1/views/FILES/versions/0.1.0
 
{
  "href" : "http://c6401.ambari.apache.org:8080/api/v1/views/FILES/versions/0.1.0/",
  "ViewVersionInfo" : {
    "archive" : "/var/lib/ambari-server/resources/views/work/FILES{0.1.0}",
    "label" : "Files",
    "masker_class" : null,
    "parameters" : [
      {
        "name" : "dataworker.defaultFs",
        "description" : "FileSystem URI",
        "required" : true,
        "masked" : false
      },
      {
        "name" : "dataworker.username",
        "description" : "The username (defaults to ViewContext username)",
        "required" : false,
        "masked" : false
      }
    ],
    "version" : "0.1.0",
    "view_name" : "FILES"
  },
  "permissions" : [ ],
  "instances" : [
    {
      "href" : "http://c6401.ambari.apache.org:8080/api/v1/views/FILES/versions/0.1.0/instances/MyFiles",
      "ViewInstanceInfo" : {
        "instance_name" : "MyFiles",
        "version" : "0.1.0",
        "view_name" : "FILES"
      }
    }
  ]
}

直接访问 View 实例。

http://c6401.ambari.apache.org:8080/views/FILES/0.1.0/MyFiles/
 
or
 
http://c6401.ambari.apache.org:8080/#/main/views/FILES/0.1.0/MyFiles

创建 View 实例：Capacity Scheduler View​

以下示例展示如何创建 Capacity Scheduler View 的实例：名称为 CAPACITY-SCHEDULER、版本为 0.1.0，实例名称为 "CS_1"，并使用标签 "Capacity Scheduler"。

  • 创建 View 实例。
POST /api/v1/views/CAPACITY-SCHEDULER/versions/0.1.0/instances/CS_1

[ {
"ViewInstanceInfo" : {
    "label" : "Capacity Scheduler",
    "properties" : {
      "ambari.server.url" : "http://c6401.ambari.apache.org:8080/api/v1/clusters/MyCluster",
      "ambari.server.username" : "admin",
      "ambari.server.password" : "admin"
    }
  }
} ]

201 - CREATED
信息

创建 View 实例时，请务必提供所有必需的 View 实例属性，否则将收到 500 响应，并附带说明所需属性的消息。

  • 确认新创建的 View 实例可用。
GET /api/v1/views/CAPACITY-SCHEDULER/versions/0.1.0

{
  "href" : "http://c6401.ambari.apache.org:8080/api/v1/views/CAPACITY-SCHEDULER/versions/0.1.0/",
  "ViewVersionInfo" : {
    "archive" : "/var/lib/ambari-server/resources/views/work/CAPACITY-SCHEDULER{0.1.0}",
    "label" : "Capacity Scheduler",
    "masker_class" : null,
    "parameters" : [
      {
        "name" : "ambari.server.url",
        "description" : "Target Ambari Server REST API cluster URL (for example: http://ambari.server:8080/api/v1/clusters/c1)",
        "required" : true,
        "masked" : false
      },
      {
        "name" : "ambari.server.username",
        "description" : "Target Ambari administrator username (for example: admin)",
        "required" : true,
        "masked" : false
      },
      {
        "name" : "ambari.server.password",
        "description" : "Target Ambari administrator password (for example: admin)",
        "required" : true,
        "masked" : false
      }
    ],
    "version" : "0.1.0",
    "view_name" : "CAPACITY-SCHEDULER"
  },
  "permissions" : [ ],
  "instances" : [
    {
      "href" : "http://c6401.ambari.apache.org:8080/api/v1/views/CAPACITY-SCHEDULER/versions/0.1.0/instances/CS_1",
      "ViewInstanceInfo" : {
        "instance_name" : "CS_1",
        "version" : "0.1.0",
        "view_name" : "CAPACITY-SCHEDULER"
      }
    }
  ]
}
  • 直接访问 View 实例。
http://c6401.ambari.apache.org:8080/views/CAPACITY-SCHEDULER/0.1.0/CS_1/

or

http://c6401.ambari.apache.org:8080/#/main/views/CAPACITY-SCHEDULER/0.1.0/CS_1/