Cloudera Manager API v18

介绍

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

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

HTTP MethodOperation
POSTCreate entries
GETRead entries
PUTUpdate or edit entries
DELETEDelete entries

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

CollectionPOST (create)GET (read)PUT (update)DELETE (delete)
/usersCreate a new userList all users in the systemBulk update all usersDelete all users
/users/fooerrorRead 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的使用教程

Tutorial link.

API 版本

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

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

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

API Version

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

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

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

REST资源

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

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

数据模型

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

数据元素

转自:https://blog.csdn.net/sccdcwc/article/details/81173002

参考:https://www.cloudera.com/documentation/enterprise/latest/topics/cm_intro_api.html

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值