更新时间:2022-07-29 GMT+08:00
分享

构造请求

本节介绍REST API请求的组成,并以调用rest_token服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。

请求URI

请求URI由如下部分组成:

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

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

参数

描述

URI-scheme

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

Endpoint

指定承载REST服务端点的服务器域名或IP

resource-path

资源路径,也即API访问路径。从具体APIURI模块获取,例如获取用户Token”APIresource-path“/oauth2/oauth/rest_token”

query-string

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

表8.3.1-1 URI中的参数说明

例如您需要获取在“global”区域的用户Token,则需使用“global”区域的Endpoint(isdpcloud.huawei.com),并在获取用户Token的URI部分找到resource-path(/oauth2/oauth/rest_token),拼接起来如下所示。

https://isdpcloud.huawei.com/oauth2/oauth/rest_token

图8.3.1-1 URI示意图

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

请求方法

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

方法

说明

GET

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

POST

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

表8.3.1-2 HTTP方法

在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:

POST https://isdpcloud.huawei.com/oauth2/oauth/rest_token

请求消息头

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

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

名称

描述

是否必选

示例

Content-Type

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

application/json

Authorization

用户Token

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

请求响应成功后在响应体(Body)中,token = token_type + " "+ access_token,中间为英文输入法下的一个空格

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

注:示例token口令为:

bearer 1367d1b0-4716-475d-8b27-c80c5f7bd3ce

,beaer后加一个英文输入法下的空格

表8.3.1-3 公共请求消息头

对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。

POST https://isdpcloud.huawei.com/oauth2/oauth/rest_token
Content-Type: application/json

请求消息体(可选)

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

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

分享:

    相关文档

    相关产品