Openstack API 開發 快速入門

    Openstack 做為流行的開源雲計算平台，其最大特性是利用其提供的基礎設施ＡＰＩ，讓我們可以以軟件的方式來動態管理ＩＡＡＳ資源。Openstack 提供的ａｐｉ是流行的Rest ＡＰＩ.

    閑話少說，我們來開始使用Openstack API。

   

   前提：搭建Openstack 環境是必須，可以根據參考資料搭建一個單機虛擬機環境.

 

   假設我們搭建的環境信息為：

   

物理服務器地址: 192.168.1.1
管理員用戶名:admin
管理員密碼:password
管理員租戶ID:3942bfc544a24f748788c06dbc486ffa

 

 

   做好環境后，我們先驗證一下，ＡＰＩ是否正常工作.使用Curl工具驗證;

curl -k -X 'POST' -v http://192.168.1.1:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "admin", "password":"password"}, "tenantId":"3942bfc544a24f748788c06dbc486ffa"}}' -H 'Content-type: application/json'

返回一串的json字符串:

{
  "access" : {
    "token" : {
      "expires" : "2013-01-23T04:26:01Z",
      "id" : "9bc5f651f5ff44329f67a5a33486fcf4",
      "tenant" : {
        "description" : null,
        "enabled" : true,
        "id" : "3942bfc544a24f748788c06dbc486ffa",
        "name" : "admin"
      }
    },
    "serviceCatalog" : [ {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa",
        "publicURL" : "http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa"
      } ],
      "endpoints_links" : [ ],
      "type" : "compute",
      "name" : "nova"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:9696/",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:9696/",
        "publicURL" : "http://192.168.1.1:9696/"
      } ],
      "endpoints_links" : [ ],
      "type" : "network",
      "name" : "quantum"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:9292/v2",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:9292/v2",
        "publicURL" : "http://192.168.1.1:9292/v2"
      } ],
      "endpoints_links" : [ ],
      "type" : "image",
      "name" : "glance"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:8776/v1/3942bfc544a24f748788c06dbc486ffa",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:8776/v1/3942bfc544a24f748788c06dbc486ffa",
        "publicURL" : "http://192.168.1.1:8776/v1/3942bfc544a24f748788c06dbc486ffa"
      } ],
      "endpoints_links" : [ ],
      "type" : "volume",
      "name" : "cinder"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:8773/services/Admin",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:8773/services/Cloud",
        "publicURL" : "http://192.168.1.1:8773/services/Cloud"
      } ],
      "endpoints_links" : [ ],
      "type" : "ec2",
      "name" : "ec2"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:8080/v1",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:8080/v1/AUTH_3942bfc544a24f748788c06dbc486ffa",
        "publicURL" : "http://192.168.1.1:8080/v1/AUTH_3942bfc544a24f748788c06dbc486ffa"
      } ],
      "endpoints_links" : [ ],
      "type" : "object-store",
      "name" : "swift"
    }, {
      "endpoints" : [ {
        "adminURL" : "http://192.168.1.1:35357/v2.0",
        "region" : "RegionOne",
        "internalURL" : "http://192.168.1.1:5000/v2.0",
        "publicURL" : "http://192.168.1.1:5000/v2.0"
      } ],
      "endpoints_links" : [ ],
      "type" : "identity",
      "name" : "keystone"
    } ],
    "user" : {
      "username" : "admin",
      "roles_links" : [ ],
      "id" : "89b0ec701354421fa2284667d4175af7",
      "roles" : [ {
        "id" : "12833eaa4ff14e8ea1e1c2f96ea6f18d",
        "name" : "KeystoneServiceAdmin"
      }, {
        "id" : "31e298db6ece43c2b85f21f2a696809e",
        "name" : "admin"
      }, {
        "id" : "8cc376e9218a4068af4cb5a923c0f201",
        "name" : "KeystoneAdmin"
      }, {
        "id" : "bb4d1cf04bcb4be59bb2b78f9a273a9c",
        "name" : "ResellerAdmin"
      } ],
      "name" : "admin"
    }
  }
}

需要的是前面幾行：

{"access": {"token": {"expires": "2013-01-23T02:22:40Z", "id": "dba0a6722b86483e83b07e5556bafb02"...

其中的ID一項，即為我們以后認證需要的token，記下來:

X-Auth-Token:dba0a6722b86483e83b07e5556bafb02

 

其它的server 及region信息，是根據你的keystone配置，會將各個服務的訪問地址(endpoint)列出來，你可以從這里獲得Image,compute,volume等ＡＰＩ接口訪問地址.

 

特別提醒：

認證的請求json字符串正確格式為:

{
    "auth":{
        "passwordCredentials":{
            "username":"admin",
            "password":"password"
        },
        "tenantId":"3942bfc544a24f748788c06dbc486ffa"
    }
}

缺少了tenantId選項依然可以獲得token ，然而這樣的token只能在keystone組件中使用，當使用此token去nova 或者image組件認證時，會失敗(401錯誤)

而截止目前，官方api文檔 http://api.openstack.org/api-ref.html 為

 

   tenantName (可選項),按此文檔請求會出現token不能在其它組件中認證的情況.

 

獲得正確的的tokens后，便可以參考官方的api參考頁面，測試其它的api了.

如instance  列表:

curl -v -H "X-Auth-Token:dba0a6722b86483e83b07e5556bafb02" http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa/servers

curl畢竟是命令行，比較麻煩，大家可以使用rest客戶端去操作。這里推存一個JAVA的:

 

https://code.google.com/p/rest-client/

 

下面我們通過API完成創建一個虛擬機的工作.

 

第一步：獲取鏡像列表:

協議為 GET http://192.168.1.1:9292/v1/images

這里使用Rest-client提交

我們選一個鏡像id: 03419abb-c27f-4dde-bc74-b8387d1ccb30

 

第二步：獲取虛擬機創建方案.

協議為: GET http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa/flavors

 

使用rest-client請求:

選取一個flavorid:100

 

第三步，創建虛擬機

協議:POST http://192.168.1.1:8774/v2/3942bfc544a24f748788c06dbc486ffa/servers

BODY:

{
    "server":{
        "flavorRef":"100",
        "imageRef":"03419abb-c27f-4dde-bc74-b8387d1ccb30",
        "metadata":{
            "My Server Name":"Apache1"
        },
        "name":"new-server-test",
        "personality":[
            {
                "contents":"",
                "path":"/etc/banner.txt"
            }
        ]
    }
}

 

restclient 請求:

由於我的虛擬機資源用限，超出容量，所以創建失敗了。成功的請求是這樣的

{
    "server":{
        "adminPass":"MVk5HPrazHcG",
        "id":"5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "links":[
            {
                "href":"http://openstack.example.com/v2/openstack/servers/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
                "rel":"self"
            },
            {
                "href":"http://openstack.example.com/openstack/servers/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
                "rel":"bookmark"
            }
        ]
    }
}

 

結果可以登錄http://192.168.1.1

用openstack 的Horizon的驗證。

其它的api可以參考Openstack的文檔完成了 http://api.openstack.org

 

常用工具

 

JSON格式化

    <http://www.cnblogs.com/biangbiang/archive/2013/01/11/2856431.html>

Java REST Client

    <http://rest-client.googlecode.com/>

Groovy RESTCLIENT (groovyx.net.http.RESTClient)    

    <http://groovy.codehaus.org/modules/http-builder/doc/rest.html>

HttpClient入門

    <http://www.ibm.com/developerworks/cn/opensource/os-httpclient/>

    <http://www.ibm.com/developerworks/cn/aix/library/au-aix-systemsdirector/section2.html>