GaussDB-构造请求

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

请求URI由如下部分组成：

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

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

表1 URI中的参数说明
参数	描述
URI-scheme	表示用于传输请求的协议，当前所有API均采用HTTPS协议。
Endpoint	终端节点（Endpoint）为任意一台部署了云数据库GaussDB管理平台（TPOPS）的节点的“IP:端口”，默认端口为8002。
resource-path	资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/mini-token”。
query-string	查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

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

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

POST https://{{Endpoint}}/rds/v3/auth/mini-token

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

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

名称	描述	是否必选	示例
Host	请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。	否	code.test.com or code.test.com:443
Content-Type	发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。	是	application/json
Content-Length	请求body长度，单位为Byte。	否	3495
X-Mini-Token	用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Mini-Token”的值即为Token值。	否使用Token认证时该字段必选	Token示例片段： MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

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

POST https://{{Endpoint}}/rds/v3/auth/mini-token 
Content-Type: application/json

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

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

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，password为用户登录密码。

POST https://{{Endpoint}}/rds/v3/auth/mini-token
{
       "username" : "test",
       "password": "***"
}

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

posted @ 2024-11-18 14:29 jerrywang1983 阅读(2) 评论(0) 收藏举报

刷新页面返回顶部

jerrywang1983