人脸检索服务提供的所有接口采用HTTP接口调用，在POST数据包中打包接口的相关设置。本文介绍人脸检索服务提供的所有接口的通用参数。

POST接口

在POST数据包中，您需要打包接口名称（function_name）、函数形参字典（function_param）及待上传数据等。如果您未开通OSS和Elasticsearch，属于Public OSS公共模式下的试用用户，则需要额外打包uid和uid_key进行校验。接口的统一格式如下：
  • 接口格式
    您可以通过POST相关字段调用检索服务提供的所有接口，接口的统一格式如下所示。
    {
    # "uid": "yourUid",         # Public OSS 用户必填。
    # "uid_key" : "yourUidKey", # Public OSS 用户必填。
    "function_name": "XXX", #必选，调用接口的名称。
    "function_params": {
        param1: XXX #参考不同接口对应的参数说明。
        param2:
        ....
    },
}
  • 输入参数
    参数 是否必选 描述 Type
    uid 否 阿里云唯一的账号ID，获取方式请参见如何查看主账号UID？。如果您是Public OSS用户，即没有在初始化前开通OSS和阿里云ElasticSearch，则必须填写该参数。 STRING
    uid_key 否 调用初始化接口时返回的uid_key。如果您是Public OSS用户，即没有在初始化前开通OSS和阿里云ElasticSearch，则必须填写该参数。 STRING
    function_name 是 初始化、数据库管理层或数据库层的接口名称。 STRING
    function_params 不同function_name的要求不同 请参考function_name对应的接口说明。 DICT
  • 返回参数

    请参考function_name对应的接口说明文档。