检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接口使用说明 查询API版本信息 裸金属服务器生命周期管理 裸金属服务器状态管理 裸金属服务器规格管理 裸金属服务器网卡管理 裸金属服务器云硬盘管理 裸金属服务器元数据管理 裸金属服务器租户配额管理 裸金属服务器密码管理 Job管理 裸金属服务器的标签管理 裸金属服务器SSH密钥管理(OpenStack原生)
历史API 接口使用说明(OpenStack Nova API) 查询API版本信息(OpenStack Nova API) 裸金属服务器生命周期管理(OpenStack Nova API) 裸金属服务器状态管理(OpenStack Nova API) 裸金属服务器元数据管理(OpenStack
API概览 接口介绍 裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。 表1 接口说明 类型 子类型 说明 BMS接口 查询API版本信息 查询裸金属服务器服务当前所用的API版本。 生命周期管理 可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。
查询API版本信息(OpenStack Nova API) 查询API版本信息列表 查询指定API版本信息 父主题: 历史API
如何调用API 构造请求 认证鉴权 返回结果
查询API版本信息 查询API版本信息列表 查询指定API版本信息 父主题: API
接口使用说明(OpenStack Nova API) 网络相关服务API,请参考《虚拟私有云API参考》。 专属分布式存储相关API,请参考《专属分布式存储API参考》。 使用OpenStack原生接口时,您需要使用ECS服务的终端节点(Endpoint),获取方式请参见地区和终端节点。
查询指定API版本信息 功能介绍 返回指定API版本的信息。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 api_version 是 API版本号。例如:v2 请求参数 无 请求示例 查询v2版本的API版本信息。 1
查询指定API版本信息 功能介绍 查询裸金属服务器指定API版本的信息。 调试 您可以在API Explorer中调试该接口。 URI GET /{api_version} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 api_version 是 API版本号。例如:v1
版本ID(版本号),如v1。 links Array of objects API的URL地址。 href String 当前API版本的引用地址。 rel String 当前API版本和被引用地址的关系。 version String 若该版本API支持微版本,则为支持的最大微版本号;如果不支持微版本,则为空。
查询API版本信息列表 功能介绍 查询裸金属服务器当前所有可用的API版本。 调试 您可以在API Explorer中调试该接口。 URI GET / 请求参数 无 请求示例 查询当前所有可用的API版本。 1 GET https://{BMS Endpoint}/ 响应参数 参数
接口使用说明 网络相关服务API,请参考《虚拟私有云API参考》。 包周期裸金属服务器的创建和退订流程中涉及和运营类接口交互,详细信息请参见运营能力简介。 专属分布式存储相关API,请参考《专属分布式存储API参考》。 使用BMS提供的接口时,您需要使用BMS服务自身的终端节点(
查询裸金属服务器网卡信息 功能介绍 查询裸金属服务器的网卡信息,比如网卡的IP地址、MAC地址。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/baremetalservers/{server_id}/os-interface
查询裸金属服务器标签 功能介绍 查询指定裸金属服务器的标签信息。 TMS使用该接口查询指定裸金属服务器的全部标签数据。 调试 您可以在API Explorer中调试该接口。 URI GET /v1/{project_id}/baremetalservers/{server_id}/tags
态。 异常响应要素 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息,详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。
Job管理 查询Job状态 父主题: API
裸金属服务器状态管理(OpenStack Nova API) 修改裸金属服务器名称(废弃) 启动裸金属服务器(废弃) 重启裸金属服务器(废弃) 关闭裸金属服务器(废弃) 获取远程登录地址(废弃) 父主题: 历史API
裸金属服务器网卡管理(OpenStack Nova API) 查询裸金属服务器网卡信息(废弃) 查询指定裸金属服务器网卡信息(废弃) 父主题: 历史API
态。 异常响应要素 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息,详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。
态。 异常响应要素 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息,详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。