云服务器内容精选

  • 响应消息 响应参数如表1所示。 表1 响应参数 参数 参数类型 描述 versions Object API版本信息列表,详情请参见表2。 表2 versions字段数据结构说明 参数 参数类型 描述 id string 所讨论的版本的通用名称,仅仅是信息性的,它没有真正的语义。 links Object 版本相关标记快捷链接信息,详情请参见表3。 min_version string 如果API的这个版本支持微版本,则支持最小的微版本。 如果不支持微版本,这将是空字符串。 status string API版本的状态。 CURRENT,这是使用的API的首选版本 SUPPORTED,这是一个较老的,但仍然支持的API版本。 DEPRECATED,一个被废弃的API版本,该版本将被删除。 version string 如果API的这个版本支持微版本,则支持最大的微版本。 如果不支持微版本,这将是空字符串。 updated string 一个有特定值的字符串。 API版本为2.0时,值为2011-01-21T11:33:21Z,API版本是2.1时,值为 2013-07-23T11:33:21Z。 表3 links字段数据结构说明 参数 参数类型 描述 href string 相应资源的链接。 rel string self:自助链接包含版本链接的资源。立即链接后使用这些链接。 bookmark:书签链接提供了一个永久资源的永久链接,该链接适合于长期存储。 alternate:备用链接可以包含资源的替换表示形式。 例如,OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。
  • 响应示例 { "versions":[ { "min_version":"", "links":[ { "rel":"self", "href":"https://{endpoint}/v2/" } ], "id":"v2.0", "updated":"2011-01-21T11:33:21Z", "version":"", "status":"SUPPORTED" }, { "min_version":"2.1", "links":[ { "rel":"self", "href":"https://{endpoint}/v2.1/" } ], "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": [ { "status": "CURRENT", "id": "v2.0", "links": [ { "href": "https://{Endpoint}/v2.0", "rel": "self" } ] } ] }
  • 响应参数 表1 响应参数 参数名称 类型 说明 versions Array of version objects API版本列表,请参见表2。 表2 version对象 参数名称 类型 说明 status String API版本的状态: CURRENT(当前版本) STABLE(稳定版本) DEPRECATED(废弃版本) id String API版本。 links Array of link objects 链接列表,请参见表3。 表3 link对象 参数名称 类型 说明 href String API链接。 rel String API链接与该API版本的关系。
  • 响应参数 参数 参数类型 描述 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 表1 响应Body参数 参数 参数类型 描述 versions Array of ApiVersionInfo objects 可用API版本列表。 表2 ApiVersionInfo 参数 参数类型 描述 id String API版本号。 取值:由高到低版本分别为v3,v2,v2.0。 status String API版本的状态。 取值: CURRENT:当前版本。 STABLE:稳定版本。 DEPRECATED:废弃版本。 说明: 所有支持的API版本中最高版状态为CURRENT,其他版本状态为STABLE。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 versions Array of VersionDetail objects 描述version相关对象的列表 表3 VersionDetail 参数 参数类型 描述 id String 版本ID(版本号)。 links Link object API的URL地址 version String 若该版本API支持微版本,则填支持的最大微版本号,如果不支持微版本,则填空。 status String 版本状态,为如下3种: CURRENT:表示该版本为主推版本; SUPPORTED:表示为老版本,但是现在还继续支持; DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String 版本发布时间,要求用UTC时间表示。如v1发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本,则填支持的最小微版本号, 如果不支持微版本,则填空。 表4 Link 参数 参数类型 描述 href String 链接 rel String 描述
  • 响应示例 状态码: 200 查询成功 { "versions" : [ { "id" : "v2", "links" : { "href" : "https://swr-api.xxxx.myhuaweicloud.com/v2/", "rel" : "self" }, "min_version" : "2.0", "status" : "CURRENT", "updated" : "2020-07-09T00:00:00Z", "version" : "2.26" } ] }
  • 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 versions Array of ApiVersionDetail objects 描述version 相关对象的列表,详情请参见 versions字段数据结构说明。 表2 ApiVersionDetail 参数 参数类型 描述 id String 版本ID(版本号),如“v1.0”。 links Array of ApiLink objects JSON对象,详情请参见links字段数据结构说明。 version String 若该版本API支持微版本,则填支持的最大微版本号,如果不支持微版本,则返回空字符串。 status String 版本状态,包含如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String 版本发布时间,要求用UTC时间表示。如v1.发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本,则填支持的最小微版本号,如果不支持微版本,则返回空字符串。 表3 ApiLink 参数 参数类型 描述 href String API的URL地址。 rel String 默认值self。 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表5 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码: 502 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码: 504 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息