云服务器内容精选

  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 versions Object API版本详细信息列表。 详情请参见表3。 version Object API版本详细信息列表。 详情请参见表3。 表3 versions字段数据结构说明 名称 参数类型 说明 id String API版本号。 links Array 对应该API版本的链接信息,该字段为空。 详情请参见表4。 status String 版本状态。 updated String 版本更新时间,格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中,T指某个时间的开始;Z指UTC时间。 表4 links字段数据结构说明 名称 参数类型 说明 href String 对应该API的URL,该字段为""。 rel String 取值为“self”,表示href为本地链接。 正常响应样例 { "version": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" }, "versions": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } } 异常响应 请参见异常请求结果。
  • 响应消息 参数说明 表1 参数说明 名称 参数类型 是否必选 描述 versions Array of objects 否 API版本详细信息列表。详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 API版本号。 links Array of objects 是 对应该API的链接信息。详情请参见表3。 说明: v3版本该字段为[]。 status String 是 版本状态。 取值为“CURRENT”,表示该版本目前已对外公布。 version String 是 API版本的子版本信息。 min_version String 是 API版本的最小版本号。 updated String 是 版本更新时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始,Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 是否必选 描述 href String 否 对应该API的URL,该字段为""。 rel String 否 取值为“self”,表示URL为本地链接。 响应示例 { "versions": [ { "id": "v3", "links": [], "status": "CURRENT", "version": "", "min_version": "", "updated": "2017-02-07T17:34:02Z" } ] }
  • 功能介绍 返回指定版本的信息。 为了支持功能不断扩展,Nova API支持版本号区分。Nova中有两种形式的版本号: "主版本号": 具有独立的url。 "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来使用,从 2.27 版本开始支持新的微版本头:OpenStack-API-Version。 如果使用OpenStack-API-Version的请求头,version对应的value取值格式为 compute 微版本号。 例如:key为OpenStack-API-Version的时候value需要填compute 2.27。
  • 响应示例 { "version":{ "min_version":"2.1", "media-types":[ { "type":"application/vnd.openstack.compute+json;version=2.1", "base":"application/json" } ], "links":[ { "rel":"self", "href":"https://{endpoint}/v2.1/" }, { "rel":"describedby", "href":"http://docs.openstack.org/", "type":"text/html" } ], "id":"v2.1", "updated":"2013-07-23T11:33:21Z", "version":"2.60", "status":"CURRENT" } }
  • 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 versions Object 指定版本信息,详情请参见表3。 表3 versions字段数据结构说明 参数 参数类型 描述 id string 所讨论的版本的通用名称。仅仅是信息性的,它没有真正的语义。 links Object 链接到资源的问题。有关更多信息,请参见OpenStack Documentation。 详情请参见表4。 media-types Object 媒体类型。详情请参见表5。 min_version string 如果API的这个版本支持微版本,则支持最小的微版本。 如果不支持微版本,这将是空字符串。 status string API版本的状态: CURRENT这是使用的API的首选版本; SUPPORTED:这是一个较老的,但仍然支持的API版本; DEPRECATED:一个被废弃的API版本,该版本将被删除 updated string 一个有特定值的字符串。API版本为2.0时,值为2011-01-21T11:33:21Z ,API版本是2.1时,值为2013-07-23T11:33:21Z。 version string 如果API的这个版本支持微版本,则支持最大的微版本。 如果不支持微版本,这将是空字符串。 表4 links字段数据结构说明 参数 参数类型 描述 href string 相应资源的链接。 rel string self:自助链接包含版本链接的资源。立即链接后使用这些链接。 bookmark:书签链接提供了一个永久资源的永久链接,该链接适合于长期存储。 alternate:备用链接可以包含资源的替换表示形式。例如,OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。 表5 media-types字段数据结构说明 参数 参数类型 描述 base string 基础类型。 type string 媒体类型。
  • 状态码 正常 300 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 400 Bad Request 无效输入:缩容后的大小必须大于0并小于当前大小(当前:XX,新大小:XX) 400 Bad Request 无效输入:扩容后的大小必须大于当前大小(当前:XX,新大小:XX) 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突,请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。
  • 响应消息 参数说明 参数 参数类型 描述 versions Array of objects 所有可用的API版本列表对象,包含v1和v2。 version字段说明: 参数 参数类型 描述 id String 所使用版本的公用名称。 updated String 接口最后修改的UTC时间,格式为YYYY-MM-DDTHH:MM:SSZ status String API 版本的状态。其值为: CURRENT:当前API使用的首选版本。 SUPPORTED:表示该版本为老版本,但当前还在继续支持。 DEPRECATED:表示该版本为废弃版本,存在后续删除的可能。 links Array of objects 共享链接。参见links字段说明。 media-types Array of objects API支持的媒介类型,参见media-types字段说明。 version String 如果当前版本的API支持microversions,此处为支持的microversion的最大版本。如果不支持microversions,这将会是空字符串。 min_version String 如果当前版本的API支持microversions, 此处为支持的microversion的最小版本。如果不支持microversions, 这将会是空字符串。 links字段说明: 参数 参数类型 描述 href String API接口访问路径,作为参考。 type String 参考接口返回的信息文本类型。 rel String 链接附加描述。 media-types字段说明: 参数 参数类型 描述 base String 文本基础类型。 type String 文本类型。 响应样例 { "versions": [ { "status": "CURRENT", "updated": "2015-08-27T11:33:21Z", "links": [ { "href": "http://docs.openstack.org/", "type": "text/html", "rel": "describedby" }, { "href": "https://sfs.region.www.t-systems.com/v2/", "rel": "self" } ], "min_version": "2.0", "version": "2.28", "media-types": [ { "base": "application/json", "type": "application/vnd.openstack.share+json;version=1" } ], "id": "v2.0" } ] }
  • 响应参数 参数 参数类型 描述 version Object 描述version对象。 id String 版本ID(版本号),如v1。 links Array of objects API的URL地址。 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。 version String 若该版本API支持微版本,则为支持的最大微版本号;如果不支持微版本,则为空。 status String 版本状态,为如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String 版本发布时间,要求用UTC时间表示。 例如v1发布的时间为:2014-06-28T12:20:21Z。 min_version String 若该版本API支持微版本,则为支持的最小微版本号;如果不支持微版本,则为空。
  • 响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "version": { "min_version": "", "media-types": [ { "type": "application/vnd.openstack.compute+json;version=2", "base": "application/json" } ], "links": [ { "rel": "self", "href": "https://ecs.service.domain.com:443/v2/" }, { "rel": "describedby", "href": "http://docs.openstack.org/", "type": "text/html" } ], "id": "v2.0", "updated": "1999-02-20T11:33:21Z", "version": "", "status": "SUPPORTED" } }
  • 响应参数 参数 参数类型 描述 versions Array of objects 描述裸金属服务器API版本信息列表。详情请参见表1。 表1 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID。 links Array of objects API的url地址。详情请参见表2。 min_version String API支持的最小微版本号。 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本发布时间。 时间戳格式为ISO 8601:YYYY-MM-DDTHH:MM:SSZ,例如:2018-09-30T00:00:00Z version String API支持的最大微版本号。 表2 links字段数据结构说明 参数 参数类型 描述 href String API的url地址。 rel String API的url地址依赖。取值为: self:包含版本号的资源链接,需要立即跟踪时使用此类链接。 bookmark:提供了适合长期存储的资源链接。
  • 响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "versions": [ { "id": "v1", "links": [ { "href": "http://bms.xxx.com/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } ] }
  • 响应示例 { "versions": [ { "id": "v1.0", "links": [ { "href": "https//deh.xxx.com/v1.0/", "rel": "self" } ], "min_version": "", "status": "SUPPORTED", "updated": "2016-12-01T11:33:21Z", "version": "" } ] }
  • 响应消息 表1 响应参数 参数 参数类型 描述 versions Array of objects 专属主机API版本信息列表。 表2 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID。 links Array of objects API的url地址。 min_version String 若该版本API支持微版本,则为支持的最小微版本号;如果不支持微版本,则为空。 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本更新时间,用UTC时间表示。 version String 若该版本API支持微版本,则为支持的最大微版本号;如果不支持微版本,则为空。 表3 links字段数据结构说明 参数 参数类型 描述 href String API的url地址。 rel String API的url地址依赖。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 version ApiVersionResponse object API版本详细信息列表。 表3 ApiVersionResponse 参数 参数类型 描述 id String API版本号。 links Array of Links objects 对应API的链接信息。 说明: v3版本该字段为[]。 status String 版本状态。 version String API版本的子版本信息。 min_version String API版本的最小版本号。 updated String 版本更新时间。 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中,T指某个时间的开始,Z指UTC时间。 表4 Links 参数 参数类型 描述 href String 对应该API的URL,该字段为""。 rel String 值为“self”,表示URL为本地链接。
  • 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 versions Array of ApiVersionResponse objects API版本详细信息列表。 表2 ApiVersionResponse 参数 参数类型 描述 id String API版本号。 links Array of Links objects 对应API的链接信息。 说明: v3版本该字段为[]。 status String 版本状态。 version String API版本的子版本信息。 min_version String API版本的最小版本号。 updated String 版本更新时间。 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中,T指某个时间的开始,Z指UTC时间。 表3 Links 参数 参数类型 描述 href String 对应该API的URL,该字段为""。 rel String 值为“self”,表示URL为本地链接。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。