Rundeck集成：WebApi方式集成示例介绍

这篇文章介绍一下如何在Rundeck中使用Rundeck Rest Api，并结合具体的实例进行操作。

Web Api

Rundeck提供了较好的对外暴露的WebApi，可以进行更方便地集成而不需要cli。而诸如curl则基本上是所有linux的标配，另外程序之中也可以直接使用Api，rundeck的api相关信息可参看如下：

• https://docs.rundeck.com/docs/api/index.html#index

XML 和 JSON支持

API支持XML和JSON方式，虽然一些export/import的功能也支持YAML或者文本格式（text/plain）,整体在所有API级别上还是使用XML和JSON方式。而在version 14，全部支持JSON格式，而只有一个例外（/api/V/project/[PROJECT]/jobs/export）。

• 使用方式
  可以通过设定HTTP Header的Accept为application/json来获取json方式的返回结果。
  当Accept没有指定的时候，返回结果同POST或者PUT的request中的方式一样，或者会返回缺省的XML方式的请求。

认证方法

Rundeck对api的使用可以通过用户名和密码或者 token的方式来进行。

用户名密码方式

首先需要需要向如下URL进行用户名和密码的post操作

• $RUNDECK_SERVER_URL/j_security_check
• j_username: 用户名
• j_password: 密码
  注：实际就是登录的过程保存于session之中

使用token方式

这种方式首先需要生成token，使用生成的token，可以使用如下两种方式来进行使用。

• 方式1: 在HTTP Header中将token设定到X-Rundeck-Auth-Token中
• 方式2: 在url中通过参数authtoken传入

生成token

首先需要设定token，可以通过GUI先行生成相关token，登录之后在右上角的user profile的界面进行token的添加

根据如下信息创建token

可以看到如下token的信息

点击show token获取token内容

查询project的列表信息

• 缺省方式：返回XML的结果

liumiaocn:~ liumiao$ curl http://localhost:32044/api/30/projects?authtoken=vcopxmhraTC9vlNw1p5VJTlxNhQcVNbc
<result success='true' apiversion='30'>
  <projects count='2'>
    <project>
      <name>rundeck-test-cli-project</name>
      <description></description>
    </project>