更新时间:2025-01-05 GMT+08:00
分享

构造请求

本节介绍REST API请求的组成,并以调用服务的获取用户Token接口说明如何调用API。

您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987

请求示例如图1,一个请求主要由请求URI请求方法请求消息头请求消息体组成。

图1 请求示例图

请求URI

请求URI由如下部分组成:

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

表1 请求URI

参数

说明

URI-scheme

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

Endpoint

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

resource-path

资源路径,即API访问路径。从具体API的URI模块获取。

query-string

查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”

获取请求URI的步骤详见请求URI,示例如下:

https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions

请求方法

HTTP请求方法,表示服务正在请求操作类型,包括:

  • GET:请求服务器返回指定资源。
  • PUT:请求服务器更新指定资源。
  • POST:请求服务器新增资源或执行特殊操作。
  • DELETE:请求服务器删除指定资源,如删除对象等。
  • HEAD:请求服务器资源头部。
  • PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

在接口的URI部分,请求方法为“POST”,例如:

POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/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}/chat/completions
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD... 

请求消息体

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

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

将消息体加入后的请求如下所示,详细参数解释可参考文档API章节。
POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD... 
{
    "messages": [
      {
          "content": "介绍下长江,以及长江中典型的鱼类"
       }
      ],
    "temperature": 0.9,
    "max_tokens": 600
}

综上,您可以使用curlPostman或直接编写代码等方式发送请求调用API。对于接口,您可以从响应消息部分看到返回参数及参数说明。

相关文档