查询操作系统列表

最近更新时间:2019-06-17 16:57:36

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。黑石物理服务器1.0 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 黑石物理服务器1.0 API 3.0

功能描述

DescribeOs 接口用来获取指定机型所支持的操作系统。

接口访问域名:bm.api.qcloud.com

请求

请求示例

https://bm.api.qcloud.com/v2/index.php?
    Action=DescribeOs
    &<公共请求参数>
    &deviceClassCode=<设备类型>    

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,其它参数参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeOs。

参数名称 必选 类型 描述
deviceClassCode String 设备类型,通过接口 查询设备型号(DescribeDeviceClass) 获得设备类型信息。

响应

响应示例

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "osTypeId": "1",
      "osName": "BM-centos6.5",
      "osNameDisplay": "centos 6.5  64位",
      "osClass": "CentOS"
    },
    {
      "osTypeId": "3",
      "osName": "BM-debian7.8",
      "osNameDisplay": "debian 7.8  64位",
      "osClass": "Debian"
    },
    {
      "osTypeId": "4",
      "osName": "BM-rhel7.1",
      "osNameDisplay": "redhat 7.1  64位",
      "osClass": "Redhat"
    }
  ]
}

响应参数

响应参数部分包含两层结构,外层展示接口的响应结果,内层展示具体的接口内容,包括操作系统等信息。

参数名称 类型 描述
code Int 错误码,0:成功, 其他值:失败,具体含义参见 错误码
message String 错误信息。
data Array(Object) 对象数组。数组元素为操作系统信息,具体结构描述如 data 结构所示。

data结构

参数名称 类型 描述
osTypeId Int 操作系统类型 ID。
osName String 操作系统代号。
osNameDisplay String 操作系统前台展示。
osClass String 操作系统分类,如 CentOs,Debian 分类。

错误码

错误码 英文提示 错误描述
9001 InternalError.DbError 操作数据库错误

实际案例

输入

https://bm.api.qcloud.com/v2/index.php?
    Action=DescribeOs
    &SecretId=AKID52SKw5uMEy3jhpMUBqSylEBJBby6E0KC
    &Nonce=48476
    &Timestamp=1476436689
    &Region=bj
    &Signature=afRlJQ0disdT97B7uIfVB4v2KWo%3D
    &deviceClassCode=PS100v1

输出

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "osTypeId": "1",
      "osName": "BM-centos6.5",
      "osNameDisplay": "centos 6.5  64位",
      "osClass": "CentOS"
    },
    {
      "osTypeId": "3",
      "osName": "BM-debian7.8",
      "osNameDisplay": "debian 7.8  64位",
      "osClass": "Debian"
    },
    {
      "osTypeId": "4",
      "osName": "BM-rhel7.1",
      "osNameDisplay": "redhat 7.1  64位",
      "osClass": "Redhat"
    }
  ]
}