构造请求-j9九游会登录
本节介绍rest api请求的组成,并以调用iam服务的管理员创建iam用户接口说明如何调用api。
您还可以通过这个视频教程了解如何构造请求调用api: 。
请求uri
请求uri由如下部分组成。
{uri-scheme} :// {endpoint} / {resource-path} ? {query-string}
尽管请求uri包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
- uri-scheme:表示用于传输请求的协议,当前所有api均采用https协议。
- endpoint:指定承载rest服务端点的服务器域名或ip,不同服务不同区域的endpoint不同,获取方法请参考终端节点。
- resource-path:资源路径,也即api访问路径。从具体api的uri模块获取,例如“管理员创建iam用户”接口的resource-path为“/v3.0/os-user/users”。
- 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),拼接起来如下所示。
https://iam.cn-north-4.myhuaweicloud.com/v3.0/os-user/users
为查看方便,在每个具体api的uri部分,只给出resource-path部分,并将请求方法写在一起。这是因为uri-scheme都是https,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
http请求方法(也称为操作或动词),它告诉服务正在请求什么类型的操作。
- get:请求服务器返回指定资源。
- put:请求服务器更新指定资源。
- post:请求服务器新增资源或执行特殊操作。
- delete:请求服务器删除指定资源,如删除对象等。
- head:请求服务器资源头部。
- patch:请求服务器更新资源的部分内容。当资源不存在的时候,patch可能会去创建一个新的资源。
在管理员创建iam用户的uri部分,您可以看到其请求方法为“post”,则其请求为:
post https://iam.cn-north-4.myhuaweicloud.com/v3.0/os-user/users
请求消息头
附加请求头字段,如指定的uri和http方法所要求的字段。例如定义消息体类型的请求头“content-type”,请求鉴权信息等。
如下公共消息头需要添加到请求中。
- content-type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。
- x-auth-token:用户token,可选,当使用token方式认证时,必须填充该字段。用户token也就是调用获取用户token接口的响应值,该接口是唯一不需要认证的接口。
对于管理员创建iam用户接口,使用token方式认证时,添加消息头后的请求如下所示。
post https://iam.cn-north-4.myhuaweicloud.com/v3.0/os-user/users content-type: application/json x-auth-token: abcdefg....
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中content-type对应,传递除请求消息头之外的内容。如果请求消息体中参数支持中文,则中文字符必须为utf-8编码,并在content-type中声明字符编码方式,例如:content-type: application/json; charset=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-auth-token: abcdefg....
{
"user": {
"domain_id": "accountid",
"name": "username",
"password": "**********",
"email": "email",
"description": "iam user description"
}
}
到此为止,一个api请求所需要的内容已经准备完成,您可以使用curl、postman或直接编写代码等方式发送请求调用api。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨