计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
本文导读

API概览

更新时间:2024-10-22 GMT+08:00

接口介绍

裸金属服务器所提供的接口分为BMS接口与OpenStack原生接口。推荐您使用BMS接口。

表1 接口说明

类型

子类型

说明

BMS接口

查询API版本信息

查询裸金属服务器服务当前所用的API版本。

生命周期管理

可以实现包周期裸金属服务器的创建、裸金属服务器详情查询等操作。

状态管理

裸金属服务器修改名称、重装系统、启动、重启、关闭等功能。

规格管理

用于查询裸金属服务器的规格详情和规格扩展信息,比如规格ID、规格名称、CPU核数、启动源。

网卡管理

可以查询裸金属服务器网卡信息,比如网卡的IP地址、MAC地址。

云硬盘管理

裸金属服务器云硬盘挂载、卸载,以及挂载的磁盘信息查询。

元数据管理

裸金属服务器元数据包含了裸金属服务器在云平台的基本信息,例如服务器ID、主机名、网络信息等。您可以更新裸金属服务器的元数据。

租户配额管理

查询某租户名下,所有资源的配额信息,包括已使用配额。

密码管理

查询是否支持一键重置密码,如果支持,您可以对裸金属服务器重置密码。还包括Windows裸金属服务器的密码获取与清除。

查询Job状态

对于创建裸金属服务器、挂卸卷等异步API,命令下发后,会返回“job_id”,通过“job_id”可以查询任务的执行状态。

OpenStack原生接口(v2.1版本)

生命周期管理

查询类接口,包括查询裸金属服务器详情、查询裸金属服务器列表、查询裸金属服务器详情信息列表。

状态管理

状态管理接口,包括对裸金属服务器的启动、重启、关闭等接口。

元数据管理

裸金属服务器元数据包含了裸金属服务器在云平台的基本信息,例如服务器ID、主机名、网络信息等。您可以查询、更新、删除裸金属服务器的元数据。

IP信息查询

查询裸金属服务器的私有IP地址信息,包括IP地址版本(IPv4或者IPv6)和具体的IP地址。

裸金属服务器规格查询

裸金属服务器网卡查询

您可以查询裸金属服务器的所有网卡;或者根据网卡ID,查询某一个网卡的详细信息,比如网卡的IP地址、MAC地址。

云硬盘管理

您可以查询裸金属服务器所挂载的云硬盘信息;或者根据磁盘ID,查询裸金属服务器挂载的某个云硬盘信息,比如挂载目录。

SSH密钥管理

查询SSH密钥信息列表、详情,创建、删除SSH密钥等功能。

一维标签管理

裸金属服务器一维标签的增删改查。

说明:
  • 使用BMS提供的接口时,您需要使用BMS服务自身的Endpoint。
  • 使用OpenStack原生接口时,您需要使用ECS服务注册的Endpoint。
  • 当前版本调用OpenStack接口不支持HTTP长连接。

BMS接口使用限制

表2 BMS接口使用限制

类型

API

URI

使用限制

查询API版本信息

查询API版本信息列表

GET /

每分钟2000次

查询指定API版本信息

GET /{api_version}

每分钟2000次

生命周期管理

创建裸金属服务器

POST /v1/{project_id}/baremetalservers

每分钟50次

查询裸金属服务器详情

GET /v1/{project_id}/baremetalservers/detail

每分钟500次

查询裸金属服务器详情列表

GET /v1/{project_id}/baremetalservers/{server_id}

每分钟1000次

状态管理

修改裸金属服务器名称

PUT /v1/{project_id}/baremetalservers/{server_id}

每分钟100次

重装裸金属服务器操作系统

POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos

每分钟50次

启动裸金属服务器

POST /v1/{project_id}/baremetalservers/action

每分钟50次

重启裸金属服务器

POST /v1/{project_id}/baremetalservers/action

每分钟50次

关闭裸金属服务器

POST /v1/{project_id}/baremetalservers/action

每分钟50次

规格管理

查询规格详情和规格扩展信息列表

GET /v1/{project_id}/baremetalservers/flavors

每分钟500次

网卡管理

查询裸金属服务器网卡信息

GET /v1/{project_id}/baremetalservers/{server_id}/os-interface

每分钟500次

云硬盘管理

裸金属服务器挂载云硬盘

POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume

每分钟100次

裸金属服务器卸载云硬盘

DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id}

每分钟100次

查询裸金属服务器挂载的磁盘信息

GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments

每分钟500次

元数据管理

更新裸金属服务器元数据

POST /v1/{project_id}/baremetalservers/{server_id}/metadata

每分钟100次

租户配额管理

查询租户配额

GET /v1/{project_id}/baremetalservers/limits

每分钟500次

密码管理

查询是否支持一键重置密码

GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag

每分钟500次

一键重置裸金属服务器密码

PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password

每分钟50次

Windows裸金属服务器获取密码

GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password

每分钟50次

Windows裸金属服务器清除密码

DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password

每分钟50次

Job管理

查询Job状态

GET /v1/{project_id}/jobs/{jobId}

每分钟2000次

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容