更新时间:2023-11-16 gmt 08:00

构造请求-凯发k8国际娱乐官网入口

本节介绍rest api请求的组成,并以调用iam服务的来说明如何调用api,该api获取用户的token,token可以用于调用其他api时鉴权。

您还可以通过这个视频教程了解如何构造请求调用api:。

请求uri

请求uri由如下部分组成:

{uri-scheme}://{endpoint}/{resource-path}?{query-string}

尽管请求uri包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。

表1 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在“华北-北京四”区域的token,则需使用“华北-北京四”区域的endpoint(iam.cn-north-4.myhuaweicloud.com),并在的uri部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。

1
https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
图1 uri示意图

为方便查看,在每个具体api的uri部分,只给出resource-path部分,并将请求方法写在一起。这是因为uri-scheme都是https,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。

请求方法

http请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。
表2 http方法

方法

说明

get

请求服务器返回指定资源。

put

请求服务器更新指定资源。

post

请求服务器新增资源或执行特殊操作。

delete

请求服务器删除指定资源,如删除对象等。

head

请求服务器资源头部。

patch

请求服务器更新资源的部分内容。

当资源不存在的时候,patch可能会去创建一个新的资源。

在的uri部分,您可以看到其请求方法为“post”,则其请求为:

1
post https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段,如指定的uri和http方法所要求的字段。例如定义消息体类型的请求头“content-type”,请求鉴权信息等。

详细的公共请求消息头字段请参见表3
表3 公共请求消息头

名称

描述

是否必选

示例

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,项目编号。请参考章节获取项目编号。

如果是专属云场景采用ak/sk认证方式的接口请求,或者多project场景采用ak/sk认证的接口请求,则该字段必选。

e9993fc787d94b6c886cbaa340f9c0f4

x-auth-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认证”。

对于接口,由于不需要认证,所以只添加“content-type”即可,添加消息头后的请求如下所示。

1
2
post https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
content-type: application/json

请求消息体(可选)

该部分可选。请求消息体通常以结构化格式(如json或xml)发出,与请求消息头中content-type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为utf-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),get、delete操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

对于接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从获取。

scope参数定义了token的作用域,下面示例中获取的token仅能访问project下的资源。您还可以设置token的作用域为某个帐号下所有资源或帐号的某个project下的资源,详细定义请参见。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
post https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
content-type: application/json
{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

到这里为止这个请求需要的内容就具备齐全了,您可以使用、或直接编写代码等方式发送请求调用api。对于获取用户token接口,返回的响应消息头中的“x-subject-token”就是需要获取的用户token。有了token之后,您就可以使用token认证调用其他api。

分享:
网站地图