介绍

本文档描述了Cloudera Manager REST API。å所有请求和响应都以Javascript对象表示法(JSON)表示。

下面列出的API资源遵循标准的createread-update - delete (CRUD)语义，其中HTTP请求路径定义要执行的实体，而HTTP方法表示要执行的操作类型。

API中的所有集合都使用复数名称“users”，而不是单数“user”。要在系统中寻址特定的用户，请展开URL路径以包含用户标识符。例如，'/users/foo'标识用户'foo'和'/users/bar'标识用户'bar'。

Collection	POST (create)	GET (read)	PUT (update)	DELETE (delete)
/users	Create a new user	List all users in the system	Bulk update all users	Delete all users
/users/foo	error	Read information about user 'foo'	If user 'foo' exists, update their information; otherwise, error.	Delete user 'foo'

请记住，并非所有集合都支持所有操作。例如，系统中的事件是只读的;不能使用API创建新的事件。

您可以使用以下两种视图之一列出集合中的条目:“summary”或“full”。默认的“summary”视图提供关于每个条目的核心信息。“full”视图更重量级，为每个条目提供了完整的扩展视图。视图由一个名为“view”的查询参数控制。“GET /users?view=full”。

对于大多数调用，HTTP请求应该将“Content-Type”标头设置为“application/json”，除非另有规定。

身份验证

Cloudera Manager API使用了HTTP基本访问身份验证。它接受与web界面相同的用户凭证。不同的用户可能有不同的访问级别，由他们的角色定义。(请参阅用户管理API要求更多。)对于每个经过身份验证的请求，服务器都返回一个会话cookie，可以随后用于身份验证。

API在错误时返回400s和500s中的HTTP代码:

400 -无效的请求参数;畸形的请求
401 -身份验证失败
403 -授权失败
404 -未找到对象
内部API错误
503 -响应暂时不可用;调用者应该稍后重试
有关错误响应的主体的讨论，请参见/tools/echoError。

可以查询API以获取它支持的最新版本。通过向'/version' URL发出GET请求，将返回一个具有最高支持版本(例如，“v2”)的字符串。

请注意，仅支持API v1的服务器不支持此调用。在这种情况下，将返回404错误，并可用于检测服务器仅支持v1。

该版本应该预写到下面列出的其余资源的路径。不同资源的文档列出了添加特定功能的版本。

可以查询API以获取它支持的最新版本。通过向'/version' URL发出GET请求，将返回一个具有最高支持版本(例如，“v2”)的字符串。

请注意，仅支持API v1的服务器不支持此调用。在这种情况下，将返回404错误，并可用于检测服务器仅支持v1。

该版本应该预写到下面列出的其余资源的路径。不同资源的文档列出了添加特定功能的版本。

此API支持通过一组固定的操作访问一组资源的代表性状态传输(Representational State Transfer, REST)模型。通过RESTful模型可以访问以下资源:

这也是一个描述REST API的WADL文档。

所有端点都对一组公共数据进行操作。Cloudera Manager API使用了JSON。

lin502

发布了43 篇原创文章 · 获赞 34 · 访问量 19万+

私信关注