如何使用华为云的API
华为云API符合RESTful API的设计理论。
REST从资源的角度来观察整个网络,分布在各处的资源由URI(Uniform Resource Identifier)确定,而客户端的应用通过URL(Unified Resource Locator)来获取资源。
调用接口的格式:
URL的一般格式为:https://Endpoint/uri
URL中的参数说明如表1-1所示。
参数 | 描述 |
Endpoint | Web服务入口点的URL,从地区和终端节点中获取。 |
uri | 资源路径,也即API访问路径。从具体接口的URI模块获取,例如“v3/auth/tokens”。 |
地区和终端节点的连接地址:http://developer.huaweicloud.com/endpoint.html
在HTTP协议中,请求可以使用多种请求方法例如GET、 PUT、 POST、 DELETE、PATCH,用于指明以何种方式来访问指定的资源,目前提供的REST接口支持的请求方法如下表1-2所示。
调用接口的方法
表1-2请求方法一览表
方法 | 说明 |
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
POST | 请求服务器新增资源或执行特殊操作。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
PATCH | 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
调用接口的认证方式
· 调用接口有如下两种认证方式,您可以任选其中一种进行认证鉴权。
· Token认证:通过Token认证调用请求。
· AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。
本文主要介绍,如何使用postman通过token认证的方式调用华为云的API
1、发送“POST https://IAM的Endpoint/v3/auth/tokens”,获取IAM的Endpoint及消息体中的区域名称。
请参考地区和终端节点。
当服务区域名称为“所有”时,选择“中国华北区1”的Endpoint。
请求内容示例如下:
下面示例代码中的红色字需要替换为实际内容
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "password",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"id": "0215ef11e49d4743be23dd97a1561e91" //假设id是"0215ef11e49d4743be23dd97a1561e91"
}
}
}
}
2、请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
3、调用业务接口,在请求消息头中增加“X-Auth-Token”,“X-Auth-Token”的取值为2中获取的Token。
在调用接口的时候,部分URL中需要填入项目编号(project_id或者tenant_id,本文中project_id和tenant_id含义一样),所以需要先在管理控制台上获取到项目编号。项目编号获取步骤如下:
注册并登录管理控制台。
单击用户名,在下拉列表中单击“我的凭证”。
在“我的凭证”页面的项目列表中查看项目ID。
注:选择的项目ID与所属区域一定要对应的上,例如选择华南区IAM的endpoint获取token,那项目ID也要选择华南区对应的项目ID
使用postman请求调用API示例(以华南区举例)如下:
一、 获取token
在地区和终端节点上,选择对应的区域以及终端节点,本例以华南区为例
获取token的url为https://iam.cn-south-1.myhwclouds.com/v3/auth/tokens
二、 调用服务API
可以参考服务的API文档调用API,以调用网络接口查询router为例
url为 https://vpc.cn-south-1.myhwclouds.com/v2.0/routers
将第一步获取的token填入header中X-Auth-Token对应的value中
- 点赞
- 收藏
- 关注作者
评论(0)