更新时间:2023-11-10 GMT+08:00
分享

构造请求

本节介绍REST API请求的组成,并以圆桌统一认证获取access_token接口说明如何调用API,以及使用该API获取可用的access_token。

请求URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

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

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议,当前所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如在“华北-北京四”区域圆桌的Endpoint为“roundtable.macroverse.huaweicloud.com”, 圆桌apig的Endpoint为“avatar-apigw-external-lb.cn-north-4.myhuaweicloud.com”。

resource-path

资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取access_token”API的resource-path为“v1/open/login/oauth2/token”。

query-string

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。

例如您需使用的Endpoint(avatar-apigw-external-lb.cn-north-4.myhuaweicloud.com),并在URI部分找到resource-path(/v1/open/login/oauth2/token),拼接起来如下所示。

https://avatar-apigw-external-lb.cn-north-4.myhuaweicloud.com/v1/open/login/oauth2/token
图1 URI示意图

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

请求方法

HTTP请求方法(也称为操作或动词)。它告诉服务你正在请求什么类型的操作。

表2 HTTP方法

方法

说明

GET

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

PUT

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

POST

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

DELETE

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

HEAD

请求服务器资源头部。

PATCH

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

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

请求消息头

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

如下公共消息头需要添加到请求中。

表3 公共请求消息头

名称

描述

是否必选

示例

Content-Type

消息体的类型(格式),默认取值为“application/json”,有其他取值时会在具体接口中专门说明。

application/json

X-Auth-Token

用户Token,也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

使用Token认证时该字段必选。

-

请求消息体(可选)

请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。

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

将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxx为project的名称,如cn-north-1,您可以从地区和终端节点中获取。

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

POST https://avatar-apigw-external-lb.cn-north-4.myhuaweicloud.com/v1/open/login/oauth2/token
Content-Type: application/x-www-form-urlencoded 
Accept: application/json  

Form-Data: client_id={ClientId}&client_secret={SECRET}&code=akaZnezUrkvT7KY4haEAo_KPiubG97fJZXuenXvTkMiL_UF7JdWAg5I4j4r1-PYsxhoypJjlFVx6WE7nisqzvhCsfsQQORO8DjQunZu8nLnqO3EDE7LvBbVpjU-dTS_o&grant_type=authorization_code

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。这里的code是统一认证页面登录后返回的code、clientId和clientSecret则是您的应用在圆桌中注册的应用id和secret

分享:

    相关文档

    相关产品