- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
-
私有镜像制作指南
- 制作镜像准备
- 创建虚拟机
-
安装并配置虚拟机(Linux)
- 安装虚拟机
- 启动引导文件修改(仅UEFI启动场景涉及)
- 虚拟机环境配置
- 安装Cloud-Init
- 配置Cloud-Init
- 查看Cloud-Init服务状态
- 修改引导的硬件设备驱动
- 安装bms-network-config软件包
- 安装network服务
- 安装SDI卡驱动
- 安装Hi1822网卡驱动
- 安装IB驱动(可选)
- 安装FusionServer/TaiShanServer服务器iDriver驱动
- 安装多路径软件(可选)
- 安装一键式重置密码插件
- 安全性配置
-
配置裸金属服务器远程登录
- x86:Oracle Linux 7.3/Oracle Linux 7.4/Red Hat 7系列/CentOS 7.2/CentOS 7.4/CentOS 7.5/CentOS 7.6
- x86:Oracle Linux 6系列/Red Hat 6系列/CentOS 6系列
- x86:SUSE 11 SP4
- ARM:CentOS 7
- x86:SUSE 12系列/SUSE 15系列/CentOS 7.3/EulerOS/OpenEuler/Oracle Linux 7.2
- ARM:EulerOS/OpenEuler
- x86:Ubuntu 16.04/Ubuntu 18.04
- ARM:Ubuntu 16.04、Ubuntu 18.04
- x86:Ubuntu 14.04/Debian
- 配置根分区自动扩盘
- 昇腾服务器驱动和固件安装升级
- 安装vroce驱动
- 清理文件
- 配置虚拟机(Windows)
- 获取镜像
-
FAQ
- 如何处理从Linux裸金属服务器的bond0的vlan子接口输出的报文,其源mac为bond0的mac问题?
- 如何处理SUSE 12 SP1操作系统自带的wicked模块,其概率性将bond端口模式配置不正确,进而导致IP链路不通的问题?
- 如何设置裸金属服务器CPU频率调节模式?
- 如何处理Windows裸金属服务器下发后Cloudbase-init服务异常退出的问题?
- 如何处理cloud-init-local概率性启动失败导致裸金属服务器不能正确注入数据的问题?
- x86 EulerOS 2.3 UDP报文性能调优
- 如何处理EulerOS系列操作系统在远程登录时,出现无法弹出登录指令或乱码干扰登录的问题?
- 如何对软件进行完整性校验?
- 如何检查device是否正常运行
- 附录
- 修订记录
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
- API
- 应用示例
- 公共参数
- 权限和授权项
-
历史API
- 接口使用说明(OpenStack Nova API)
- 查询API版本信息(OpenStack Nova API)
- 裸金属服务器生命周期管理(OpenStack Nova API)
- 裸金属服务器状态管理(OpenStack Nova API)
- 裸金属服务器元数据管理(OpenStack Nova API)
- 裸金属服务器IP地址查询(OpenStack Nova API)
- 裸金属服务器规格查询(OpenStack Nova API)
- 裸金属服务器网卡管理(OpenStack Nova API)
- 裸金属服务器云硬盘管理(OpenStack Nova API)
- 裸金属服务器一维标签管理(OpenStack Nova API)
- 附录
- 修订记录
- 场景代码示例
- SDK参考
-
常见问题
- 通用类
- 实例类
- 密钥对与密码类
- 登录类
-
网络与安全类
- 不同账号下裸金属服务器内网是否可以互通?
- 同一区域、不同可用区的两台裸金属服务器如何通信?
- 我创建的裸金属服务器是否在同一子网?
- 裸金属服务器是否可以关联多个安全组?
- 裸金属服务器可以和同一VPC内的弹性云服务器通信吗?
- 裸金属服务器的主网卡和扩展网卡在使用上有什么区别?
- 裸金属服务器可以绑定多个弹性公网IP吗?
- 是否可以手动设置弹性公网IP的地址?
- 已释放的弹性公网IP,再次申请会分配相同的EIP地址吗?
- 弹性公网IP、私有IP、虚拟IP之间有什么区别?
- 在只能使用SSH登录裸金属服务器的情况下,如何修改裸金属服务器的网络配置或重启网络?
- 如何处理CentOS 7系列扩展网卡无法ping通的问题?
- 如何处理业务端口被一键式重置密码插件占用?
- 如何处理裸金属服务器主网卡和扩展网卡共平面通信异常问题?
- 如何设置裸金属服务器的静态IP?
- 裸金属服务器绑定128个eth网络设备时,网络性能差,如何解决?
- 磁盘类
-
操作系统类
- 我能否自己安装或者升级操作系统?
- 裸金属服务器能否更换操作系统?
- 裸金属服务器操作系统是否有图形界面?
- 裸金属服务器操作系统自带上传工具吗?
- 裸金属服务器的公共镜像是否存在Swap分区?
- 如何设置裸金属服务器的静态主机名?
- 如何设置裸金属服务器镜像密码的有效期?
- 如何设置SSH服务配置项?
- Windows裸金属服务器的系统时间与本地时间相差8小时,如何处理?
- Windows Server 2012裸金属服务器如何修改SID值?
- CentOS 7系列裸金属服务器如何切换内核版本?
- 根分区自动扩盘的场景下,如何隔离日志空间大小?
- 误升内核的场景,如何回退至原始内核版本?
- 如何增加系统Swap交换分区的大小?
- 如何扩展快速发放裸金属服务器的根分区大小?
- Linux操作系统常用命令速查
- 重新挂载lvm卷后如何更新磁盘metadata信息
- Windows云盘裸机HA之后网络不通如何恢复?
- 故障排除
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
构造请求
本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
参数 |
描述 |
---|---|
URI-scheme |
表示用于传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 |
resource-path |
资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 |
query-string |
查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 |
例如您需要创建IAM用户,由于IAM为全局服务,则使用任一区域的Endpoint,比如“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在管理员创建IAM用户的URI部分找到resource-path(/v3.0/OS-USER/users),拼接起来如下所示。
1 |
https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users |

为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
方法 |
说明 |
---|---|
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源,如删除对象等。 |
HEAD |
请求服务器资源头部。 |
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
在管理员创建IAM用户的URI部分,您可以看到其请求方法为“POST”,则其请求为:
1 |
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users |
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
名称 |
描述 |
是否必选 |
示例 |
---|---|---|---|
Host |
请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 |
否 使用AK/SK认证时该字段必选。 |
code.test.com or code.test.com:443 |
Content-Type |
消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 |
是 |
application/json |
Content-Length |
请求body长度,单位为Byte。 |
否 |
3495 |
X-Project-Id |
project id,项目编号。请参考获取项目ID章节获取项目编号。 |
否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 |
否 使用Token认证时该字段必选。 |
注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
API同时支持使用AK/SK认证,AK/SK认证使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。
AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。
对于管理员创建IAM用户接口,使用AK/SK方式认证时,添加消息头后的请求如下所示。
1 2 3 4 |
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** |
请求消息体(可选)
该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
- accountid为IAM用户所属的账号ID。
- username为要创建的IAM用户名。
- email为IAM用户的邮箱。
- **********为IAM用户的登录密码。
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } }
到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。