- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
-
通用类
- 弹性伸缩有什么限制?
- 弹性伸缩一定要搭配弹性负载均衡、云监控才能使用吗?
- 弹性伸缩是否收取费用?
- 弹性伸缩是否会因监控指标突变导致误伸缩?
- 我能创建和使用多少个伸缩策略和配置?
- 弹性伸缩是否能够自动升降云服务器的CPU、内存和带宽?
- 弹性伸缩的配额是什么?
- 同账户下不同用户操作弹性伸缩资源时,为什么提示密钥对不存在而拦截操作?
- 伸缩带宽对弹性公网IP带宽和共享带宽有什么要求?
- 弹性伸缩目前支持配置的服务器类型有哪些?可以配置云耀云服务器(HECS)吗?
- 组内单台ECS上的程序版本会随时更新,伸缩组能否自动创建并切换为最新镜像?
- 咨询AS扩容实例时能否创建包周期实例?
- 弹性伸缩能根据某个场景将带宽调高吗?
- 伸缩组类
- 伸缩策略类
-
实例类
- 如何保证手动移入的ECS实例不被移出伸缩组?
- 多规格伸缩配置创建实例的选择的规格顺序是什么?
- 当实例被移出伸缩组并删除后,实例中的数据会保留吗?
- 我能添加已经创建的包年包月ECS实例吗?
- 按照伸缩策略增加的云服务器,当我不用时可以自动删除吗?
- 什么是期望实例数?
- 如何删除通过弹性伸缩创建的云服务器?
- 包年包月的ECS实例出现异常后会不会被伸缩组删除?
- 如何处理伸缩组中状态是“异常”的实例?
- 当伸缩组中实例无法通过负载均衡健康检查而频繁地被删除再重新创建时应该怎么办?
- 如何阻止伸缩组内的云服务器被自动移除?
- 为什么在伸缩组内移除并删除实例后,ECS页面还能看到实例?
- 手动将实例移入伸缩组时,需要该实例已绑定弹性公网IP吗?
- 弹性伸缩(AS)伸缩出来的新实例必须是伸缩组已经关联的伸缩配置里的镜像,而不能复制现有的实例状态吗?
- 为ECS自动分配的EIP,是自动新购,还是从未绑定的EIP中绑定?
- 其他
-
通用类
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
构造请求
本节介绍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。