构造请求-j9九游会登录
本节介绍rest api请求的组成,并以调用iam服务的获取用户token接口说明如何调用api,token可以用于调用其他api时的鉴权。
请求uri
请求uri由如下部分组成:
{uri-scheme} :// {endpoint} / {resource-path} ? {query-string}
|
参数 |
说明 |
|---|---|
|
uri-scheme |
传输请求的协议,当前所有api均采用https协议。 |
|
endpoint |
承载rest服务端点的服务器域名或ip,不同服务在不同区域时,对应endpoint不同,可以从中终端节点获取。 例如iam服务在“西南-贵阳一”区域的endpoint为“iam.cn-southwest-2.myhuaweicloud.com”。
说明:
获取token时使用的是iam-endpoint,为“iam-apigateway-proxy.{region_id}.{external_domain_name}”。同时需要在本地pc的hosts文件中配置域名信息,格式为“{float_ip} iam-apigateway-proxy.{region_id}.{external_domain_name}”。详细获取和配置请参见获取用户token。 |
|
resource-path |
资源路径,即api访问路径。从具体api的uri模块获取,例如“获取用户token”api的resource-path为“/v3/auth/tokens”。 |
|
query-string |
查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 |
例如您需要获取““西南-贵阳一””区域的token,则需使用““西南-贵阳一””区域的endpoint(iam.cn-southwest-2.myhuaweicloud.com),并在获取用户token的uri部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。
https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
为查看方便,服务每个具体api的uri,只给出resource-path部分,并将请求方法写在一起。这是因为uri-scheme都是https,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
http请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
get |
请求服务器返回指定资源。 |
|
put |
请求服务器更新指定资源。 |
|
post |
请求服务器新增资源或执行特殊操作。 |
|
delete |
请求服务器删除指定资源,如删除对象等。 |
|
head |
请求服务器资源头部。 |
|
patch |
请求服务器更新资源的部分内容。 当资源不存在的时候,patch可能会去创建一个新的资源。 |
post https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
请求消息头
附加请求头字段,如指定的uri和http方法所要求的字段。例如定义消息体类型的请求头“content-type”,请求鉴权信息等。
需要添加到请求中的公共消息头如表3所示。
|
参数名 |
说明 |
是否必选 |
示例 |
|---|---|---|---|
|
content-type |
消息体的类型(格式),默认取值为“application/json”。 |
是 |
application/json |
|
content-length |
请求body长度,单位为byte。 |
post/put请求必填,get不能包含。 |
3495 |
|
x-project-id |
project id,用于不同project取token。 |
否 |
e9993fc787d94b6c886cbaa340f9c0f4 |
|
x-auth-token |
用户token,也就是调用获取用户token接口的响应值,该接口是唯一不需要认证的接口。 |
否,使用token认证时必选。 |
- |
|
x-sdk-date |
请求的发生时间,格式为(yyyymmdd't'hhmmss'z')。 取值为当前系统的gmt时间。 |
否,如果使用ak/sk做接口认证的时候,那么此字段必须设置;如果使用pki token的时候,不必设置。 |
20190307t101459z |
|
authorization |
签名认证信息。 该值来源于请求签名结果,使用ak/sk进行加密签名的时候需要。 类型:字符串 默认值:无 |
否,使用ak/sk认证时必选。 |
sdk-hmac-sha256 credential=zirrkmtwptqfqi1wknkb/20150907//ec2/sdk_request, signedheaders=content-type;host;x-sdk-date, signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 |
|
host |
请求的服务器信息,从服务api的url中获取。 值为hostname[:port]。 端口缺省时使用默认的端口,https的默认端口为443。 |
否,使用ak/sk认证时必选。 |
code.test.com or code.test.com:443 |
api同时支持使用ak/sk认证,ak/sk认证是使用sdk对请求进行签名,签名过程会自动往请求中添加authorization(签名认证信息)和x-sdk-date(请求发送的时间)请求头。ak/sk认证的详细说明请参见api签名指南。
post https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens content-type: application/json
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中content-type对应,传递除请求消息头之外的内容。如果请求消息体中参数支持中文,则中文字符必须为utf-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),get、delete操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于获取用户token,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中user_name为用户名,domain_name为用户所属的账号名,user_password为用户登录密码,cn-southwest-2为项目名称,获取方法请参见获取用户名和用户id、获取账号名和账号id和获取项目名称。
scope参数定义了token的作用域,示例中获取的token仅能访问project下的资源。maas使用区域的endpoint(非全局域名)调用该接口,推荐您将scope设置为project。您还可以设置token作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户token。
post https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
content-type:application/json
{
"auth": {
"identity": {
"methods": ["password"],
"password": {
"user": {
"name": "user_name",
"password": "user_password",
"domain": {
"name": "domain_name"
}
}
}
},
"scope": {
"project": {
"name": "cn-southwest-2"
}
}
}
}
到这里为止这个请求需要的内容就具备齐全了,您可以使用、或直接编写代码等方式发送请求调用api。对于获取用户token,返回的响应消息头中“x-subject-token”的值,就是需要获取的用户token。有了token之后,您就可以使用token认证调用其他api。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨