跳转到： 导航, 搜索

API 特别兴趣小组/当前设计/版本响应

分析

对于版本请求，正在返回哪些响应？

此分析专门询问 API 服务器通过 GET 请求在“/”、“/version”、“/v1”或类似路径返回的版本信息。

OpenStack wiki 上的 版本发现页面 被用作此分析的参考点。

当前设计

Cinder

Cinder API 参考

示例

GET /
{
    "versions": [
        {
            "id": "v1.0",
            "links": [
                {
                    "href": "https://docs.openstack.org/",
                    "rel": "describedby",
                    "type": "text/html"
                },
                {
                    "href": "http://192.168.122.88:8776/v1/",
                    "rel": "self"
                }
            ],
            "media-types": [
                {
                    "base": "application/json",
                    "type": "application/vnd.openstack.volume+json;version=1"
                }
            ],
            "min_version": "",
            "status": "DEPRECATED",
            "updated": "2016-05-02T20:25:19Z",
            "version": ""
        },
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "https://docs.openstack.org/",
                    "rel": "describedby",
                    "type": "text/html"
                },
                {
                    "href": "http://192.168.122.88:8776/v2/",
                    "rel": "self"
                }
            ],
            "media-types": [
                {
                    "base": "application/json",
                    "type": "application/vnd.openstack.volume+json;version=1"
                }
            ],
            "min_version": "",
            "status": "SUPPORTED",
            "updated": "2014-06-28T12:20:21Z",
            "version": ""
        },
        {
            "id": "v3.0",
            "links": [
                {
                    "href": "https://docs.openstack.org/",
                    "rel": "describedby",
                    "type": "text/html"
                },
                {
                    "href": "http://192.168.122.88:8776/v3/",
                    "rel": "self"
                }
            ],
            "media-types": [
                {
                    "base": "application/json",
                    "type": "application/vnd.openstack.volume+json;version=1"
                }
            ],
            "min_version": "3.0",
            "status": "CURRENT",
            "updated": "2016-02-08T12:20:21Z",
            "version": "3.15"
        }
    ]
}

GET /v2
{
    "version": {
        "id": "v2.0",
        "links": [
            {
                "href": "http://23.253.211.234:8776/v2/v2.0",
                "rel": "self"
            }
        ],
        "media-types": [
            {
                "base": "application/xml",
                "type": "application/vnd.openstack.volume+xml;version=1"
            },
            {
                "base": "application/json",
                "type": "application/vnd.openstack.volume+json;version=1"
            }
        ],
        "status": "CURRENT"
    }
}

Glance

镜像服务 API v1 参考

镜像服务 API v2 参考

仅记录了 GET / 和 GET /versions 提供版本响应。

示例

GET / 和 GET /versions 返回相同的响应

{
    "versions": [
        {
            "id": "v2.3",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v2/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT"
        },
        {
            "id": "v2.2",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v1.1",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v1/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v1.0",
            "links": [
                {
                    "href": "http://brianr-dev10:9292/v1/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        }
    ]
}

GET /v2 返回 302 Found。

GET /v2/ 返回 404 Not Found。


Keystone

Keystone v2 API 参考

Keystone v3 API 参考

示例

GET /
{
    "versions": {
        "values": [
            {
                "id": "v3.4", 
                "links": [
                    {
                        "href": "http://10.0.1.107:5000/v3/", 
                        "rel": "self"
                    }
                ], 
                "media-types": [
                    {
                        "base": "application/json", 
                        "type": "application/vnd.openstack.identity-v3+json"
                    }
                ], 
                "status": "stable", 
                "updated": "2015-03-30T00:00:00Z"
            }, 
            {
                "id": "v2.0", 
                "links": [
                    {
                        "href": "http://10.0.1.107:5000/v2.0/", 
                        "rel": "self"
                    }, 
                    {
                        "href": "https://docs.openstack.org/", 
                        "rel": "describedby", 
                        "type": "text/html"
                    }
                ], 
                "media-types": [
                    {
                        "base": "application/json", 
                        "type": "application/vnd.openstack.identity-v2.0+json"
                    }
                ], 
                "status": "stable", 
                "updated": "2014-04-17T00:00:00Z"
            }
        ]
    }
}

GET /v2.0/
{
    "version": {
        "id": "v2.0", 
        "links": [
            {
                "href": "http://10.0.1.107:5000/v2.0/", 
                "rel": "self"
            }, 
            {
                "href": "https://docs.openstack.org/", 
                "rel": "describedby", 
                "type": "text/html"
            }
        ], 
        "media-types": [
            {
                "base": "application/json", 
                "type": "application/vnd.openstack.identity-v2.0+json"
            }
        ], 
        "status": "stable", 
        "updated": "2014-04-17T00:00:00Z"
    }
}

GET /v3/
{
    "version": {
        "id": "v3.4", 
        "links": [
            {
                "href": "http://10.0.1.107:5000/v3/", 
                "rel": "self"
            }
        ], 
        "media-types": [
            {
                "base": "application/json", 
                "type": "application/vnd.openstack.identity-v3+json"
            }
        ], 
        "status": "stable", 
        "updated": "2015-03-30T00:00:00Z"
    }
}


Manila

共享文件系统服务 API v1 (支持) 参考

共享文件系统服务 API v2 (当前) 参考

示例

GET /
{  
   "versions":[  
      {  
         "status":"SUPPORTED",
         "updated":"2015-08-27T11:33:21Z",
         "links":[  
            {  
               "href":"https://docs.openstack.org/",
               "type":"text/html",
               "rel":"describedby"
            },
            {  
               "href":"http://192.168.10.11:8786/v1/",
               "rel":"self"
            }
         ],
         "min_version":"",
         "version":"",
         "media-types":[  
            {  
               "base":"application/json",
               "type":"application/vnd.openstack.share+json;version=1"
            }
         ],
         "id":"v1.0"
      },
      {  
         "status":"CURRENT",
         "updated":"2015-08-27T11:33:21Z",
         "links":[  
            {  
               "href":"https://docs.openstack.org/",
               "type":"text/html",
               "rel":"describedby"
            },
            {  
               "href":"http://192.168.10.11:8786/v2/",
               "rel":"self"
            }
         ],
         "min_version":"2.0",
         "version":"2.8",
         "media-types":[  
            {  
               "base":"application/json",
               "type":"application/vnd.openstack.share+json;version=1"
            }
         ],
         "id":"v2.0"
      }
   ]
}

GET /v1/
{  
   "versions":[  
      {  
         "status":"SUPPORTED",
         "updated":"2015-08-27T11:33:21Z",
         "links":[  
            {  
               "href":"https://docs.openstack.org/",
               "type":"text/html",
               "rel":"describedby"
            },
            {  
               "href":"http://192.168.10.11:8786/v1/",
               "rel":"self"
            }
         ],
         "min_version":"",
         "version":"",
         "media-types":[  
            {  
               "base":"application/json",
               "type":"application/vnd.openstack.share+json;version=1"
            }
         ],
         "id":"v1.0"
      }
   ]
}

GET /v2/
{  
   "versions":[  
      {  
         "status":"CURRENT",
         "updated":"2015-08-27T11:33:21Z",
         "links":[  
            {  
               "href":"https://docs.openstack.org/",
               "type":"text/html",
               "rel":"describedby"
            },
            {  
               "href":"http://192.168.10.11:8786/v2/",
               "rel":"self"
            }
         ],
         "min_version":"2.0",
         "version":"2.8",
         "media-types":[  
            {  
               "base":"application/json",
               "type":"application/vnd.openstack.share+json;version=1"
            }
         ],
         "id":"v2.0"
      }
   ]
}

.

Nova

Nova API 参考

示例

GET /
{
    "versions": [
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://10.0.1.107:8774/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED",
            "version": "",
            "min_version": "",
            "updated": "2011-01-21T11:33:21Z"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://10.0.1.107:8774/v2.1/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "version": "2.12",
            "min_version": "2.1",
            "updated": "2013-07-23T11:33:21Z"
        }
    ]
}

GET /v2/
{
    "version": {
        "id": "v2.0", 
        "links": [
            {
                "href": "http://10.0.1.107:8774/v2/", 
                "rel": "self"
            }, 
            {
                "href": "https://docs.openstack.org/", 
                "rel": "describedby", 
                "type": "text/html"
            }
        ], 
        "media-types": [
            {
                "base": "application/json", 
                "type": "application/vnd.openstack.compute+json;version=2"
            }
        ], 
        "min_version": "", 
        "status": "SUPPORTED", 
        "updated": "2011-01-21T11:33:21Z", 
        "version": ""
    }
}

GET /v2.1/
{
    "version": {
        "id": "v2.1", 
        "links": [
            {
                "href": "http://10.0.1.107:8774/v2.1/", 
                "rel": "self"
            }, 
            {
                "href": "https://docs.openstack.org/", 
                "rel": "describedby", 
                "type": "text/html"
            }
        ], 
        "media-types": [
            {
                "base": "application/json", 
                "type": "application/vnd.openstack.compute+json;version=2.1"
            }
        ], 
        "min_version": "2.1", 
        "status": "CURRENT", 
        "updated": "2013-07-23T11:33:21Z", 
        "version": "2.12"
    }
}


Sahara

Sahara API 参考

示例

GET /
{
    "versions": [
        {
            "id": "v1.0", 
            "status": "SUPPORTED"
        }, 
        {
            "id": "v1.1", 
            "status": "CURRENT"
        }
    ]
}

GET /v1/ 返回 404 Not Found。

GET /v1.0/ 返回 404 Not Found。

GET /v1.1/ 返回 404 Not Found。

遥测

Telemetry 现在分为 Ceilometer、Aodh 和 Gnocchi，每个都有 独立的 API。

GET / 需要身份验证，这可能是一个错误。

注意： cdent 使用 gabbi 发现了这些信息。

示例

Ceilometer

需要身份验证 

GET /

{
   "versions" : {
      "values" : [
         {
            "updated" : "2013-02-13T00:00:00Z",
            "status" : "stable",
            "media-types" : [
               {
                  "base" : "application/json",
                  "type" : "application/vnd.openstack.telemetry-v2+json"
               },
               {
                  "type" : "application/vnd.openstack.telemetry-v2+xml",
                  "base" : "application/xml"
               }
            ],
            "id" : "v2",
            "links" : [
               {
                  "href" : "https://:8777/v2",
                  "rel" : "self"
               },
               {
                  "href" : "https://docs.openstack.org/",
                  "type" : "text/html",
                  "rel" : "describedby"
               }
            ]
         }
      ]
   }
}

GET /v2 返回 404

Aodh

需要身份验证 

GET /

{
   "versions" : {
      "values" : [
         {
            "updated" : "2013-02-13T00:00:00Z",
            "media-types" : [
               {
                  "type" : "application/vnd.openstack.telemetry-v2+json",
                  "base" : "application/json"
               },
               {
                  "base" : "application/xml",
                  "type" : "application/vnd.openstack.telemetry-v2+xml"
               }
            ],
            "links" : [
               {
                  "rel" : "self",
                  "href" : "https://:8042/v2"
               },
               {
                  "type" : "text/html",
                  "rel" : "describedby",
                  "href" : "https://docs.openstack.org/"
               }
            ],
            "id" : "v2",
            "status" : "stable"
         }
      ]
   }
}

GET /v2 返回 404

Gnocchi

在默认 devstack 中需要身份验证 

GET /

{
   "versions" : [
      {
         "links" : [
            {
               "rel" : "self",
               "href" : "https://:8041/v1/"
            }
         ],
         "updated" : "2015-03-19",
         "status" : "CURRENT",
         "id" : "v1.0"
      }
   ]
}

GET /v1/

{
   "links" : [
      {
         "href" : "https://:8041/v1",
         "rel" : "self"
      },
      {
         "href" : "https://:8041/v1/aggregation",
         "rel" : "aggregation"
      },
      {
         "href" : "https://:8041/v1/archive_policy",
         "rel" : "archive_policy"
      },
      {
         "rel" : "archive_policy_rule",
         "href" : "https://:8041/v1/archive_policy_rule"
      },
      {
         "href" : "https://:8041/v1/capabilities",
         "rel" : "capabilities"
      },
      {
         "href" : "https://:8041/v1/metric",
         "rel" : "metric"
      },
      {
         "href" : "https://:8041/v1/resource",
         "rel" : "resource"
      },
      {
         "href" : "https://:8041/v1/search",
         "rel" : "search"
      },
      {
         "rel" : "status",
         "href" : "https://:8041/v1/status"
      }
   ],
   "version" : "1.0"
}
从 "https://wiki.openstack.org/w/index.php?title=API_Special_Interest_Group/Current_Design/Version_Responses&oldid=162000" 检索