构造请求
本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。
请求示例如下图所示,一个请求主要有请求URI、请求方法、请求消息头和请求消息体组成,各个部分将在下文详细解释。
![](https://support.huaweicloud.com/api-pangulm/zh-cn_image_0000001999067182.png)
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
参数 |
说明 |
---|---|
URI-scheme |
传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
承载REST服务端点的服务器域名或IP。 |
resource-path |
资源路径,即API访问路径。从具体API的URI模块获取。 |
query-string |
查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”。 |
参考终端节点章节获取endpoint,并在接口的URI部分找到resource-path(/v1/{project_id}/deployments/{deployment_id}/text/completions),其中{project_id}需要替换成用户的项目ID。拼接起来如下所示。
https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/text/completions
![](https://support.huaweicloud.com/api-pangulm/zh-cn_image_0000002035107181.png)
![](https://support.huaweicloud.com/api-pangulm/public_sys-resources/note_3.0-zh-cn.png)
为查看方便,每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
- GET:请求服务器返回指定资源。
- PUT:请求服务器更新指定资源。
- POST:请求服务器新增资源或执行特殊操作。
- DELETE:请求服务器删除指定资源,如删除对象等。
- HEAD:请求服务器资源头部。
- PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。
在接口的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/text/completions
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
如下公共消息头需要添加到请求中。
- Content-Type:消息体的类型(格式),必选,默认取值为“application/json”。
- X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token请参考认证鉴权中的“Token认证”。
公有云API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK。
添加消息头后的请求如下所示:
POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/text/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD...
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/text/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD... { "prompt": "写一个穿越到宋朝的故事。", "max_tokens": 600, "temperature": 0.9, "n": 1 }
到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于接口,您可以从响应消息部分看到返回参数及参数说明。