云服务器内容精选

  • 响应消息 响应参数如表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 媒体类型。
  • 功能介绍 返回指定版本的信息。 为了支持功能不断扩展,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" } }
  • 响应参数 参数 参数类型 描述 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地址依赖。
  • 请求示例 获取版本信息。 GET https://{endpoint}/v2{ "version" : { "links" : [ { "rel" : "self", "href" : "https://oms.cn-north-1.myhuaweicloud.com/v1/" } ], "id" : "v2", "updated" : "2020-04-01T12:00:00Z", "status" : "SUPPORTED" }}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 id String 版本号,例如v1。 links Array of Link objects 链接地址信息。 status String 版本状态。 取值“CURRENT”,表示该版本为主推版本。 取值"SUPPORTED",表示支持该版本。 取值“DEPRECATED”,表示为废弃版本,存在后续删除的可能。 枚举值: CURRENT DEPRECATED SUPPORTED updated String 版本更新时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指UTC时间。 最小长度:0 最大长度:32 表3 Link 参数 参数类型 描述 href String 链接地址。 rel String 取值为“self”,表示href为本地链接。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 error_code String 错误码。