构造请求
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
参数 |
说明 |
---|---|
URI-scheme |
传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
承载REST服务端点的服务器域名或IP,不同服务在不同区域,Endpoint不同,可以从终端节点中获取。 例如REST服务在“华北-北京四”区域的Endpoint为“imastercloud.huawei.com”。 |
resource-path |
资源路径,即API访问路径。从具体API的URI模块获取。 例如“获取token”API的resource-path为“/controller/campus/api/v1/multiregion/tokens”。 |
query-string |
查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”。 例如“regionName=Region1”,表示调用API的区域名称为Region1。 |
例如您需要获取“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(imastercloud.huawei.com),并在获取Token接口的URI部分找到resource-path(/v1/multiregion/tokens),拼接起来如下所示。
https://imastercloud.huawei.com/controller/campus/api/v1/multiregion/tokens?regionName=Region1
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
- GET:请求服务器返回指定资源。
- PUT:请求服务器更新指定资源。
- POST:请求服务器新增资源或执行特殊操作,例如部分厂商会将复查参数查询转换为POST方法。
- DELETE:请求服务器删除指定资源,如删除对象等。
- HEAD:请求服务器资源头部。
- PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://imastercloud.huawei.com/controller/campus/api/v1/multiregion/tokens?regionName=Region1
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
如下公共消息头需要添加到请求中。
- Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。
- X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用/controller/campus/api/v1/multiregion/tokens接口的响应值,该接口无需认证,无须提供该参数。
对于获取token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。
POST https://imastercloud.huawei.com/controller/campus/api/v1/multiregion/tokens?regionName=Region1 Content-Type: application/json
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于获取token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中user_name为用户名,******为用户登录密码。
POST https://imastercloud.huawei.com/controller/campus/api/v1/multiregion/tokens?regionName=Region1 Content-Type: application/json { "userName": "user_name", "password": "******" }
到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取token接口,返回的响应消息头中“token_id”就是需要获取的用户Token。获取Token后,您就可以使用Token认证调用其他API。