构造请求

请求URI

请求URI由如下部分组成。

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

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

• URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。
• Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如LMS服务在“华北-北京四”（中国站）区域的Endpoint为“dwr-lms.cn-north-4.myhuaweicloud.com”（中国站）。
• resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“创建集合”接口的resource-path为“/v1/collections/create”。
• query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如您需要在LMS的“华北-北京四”区域创建集合，则使用“华北-北京四”区域的Endpoint（“dwr-lms.cn-north-4.myhuaweicloud.com”），并在具体API的URI部分找到resource-path（/v1/collections/create），拼接起来如下所示。

https://dwr-lms.cn-north-4.myhuaweicloud.com/v1/collections/create

图1 URI示意图

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

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

POST：请求服务器新增资源或执行特殊操作。

在创建集合的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://dwr-lms.cn-north-4.myhuaweicloud.com/v1/collections/create

请求消息头

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

如下公共消息头需要添加到请求中。

• Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
• Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。
• X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参见AK/SK认证。
• X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。

对于创建集合接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。

POST https://dwr-lms.cn-north-4.myhuaweicloud.com/v1/collections/create
Content-Type: application/json 
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码，并在Content-type中声明字符编码方式，例如：Content-Type: application/json; charset=utf-8。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），列举仓接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于创建集合接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。

• store_name为知识仓实例名称。
• collection_name为要创建集合名称。
• primary_filed为集合创建主键列。
• fields为集合中创建的其它列。
• index_pramas为集合创建索引的参数信息。

POST https://dwr-lms.cn-north-4.myhuaweicloud.com/v1/collections/create 
Content-Type: application/json 
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** 
 
{
  "store_name": "test-store",
  "collection_name": "test-collection",
  "primary_field": {
    "name": "pk",
    "type": "Int64"
  },
  "fields": [
    {
      "field_name": "vector",
      "data_type": "FloatVector",
      "element_type_params": {
        "dim": 256
      }
    }
  ],
  "index_params": {
    "index_name": "vector_index",
    "field_name": "vector"
  }
}

到此为止，一个API请求所需要的内容已经准备完成，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。