图像人脸融合模板查询QueryFaceImageTemplate的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

图像人脸融合模板查询功能可以查询用户添加过的人脸模板图。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通人脸人体服务，若未开通服务请立即开通。

重要

本能力仅限企业认证用户开通。更多实名认证操作信息，请参见实名认证。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

5. 前提条件：已通过图像人脸融合模板增加接口（AddFaceImageTemplate）创建生成了TemplateId。

6. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为人脸人体（facebody）的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

7. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

计费说明

图像人脸融合模板查询能力可免费调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	QueryFaceImageTemplate	系统规定参数。取值：QueryFaceImageTemplate。
TemplateId	String	否	6cd509ea-54fa-4730-8e9d-c94cadcda048	待查询的模板ID。如果未传TemplateId，返回该用户的模板列表；如果传入TemplateId，仅返回对应的结果。
PageNo	Long	否	1	当前页数设置，默认第1页。取值范围为1~5000。
PageSize	Long	否	100	当前页条数设置，默认100条。取值范围为1~500。

返回数据

名称	类型	示例值	描述
RequestId	String	7C29675C-751F-4D2F-86FB-2BD8D69AC860	请求ID。
Data	Object		返回的结果数据内容。
Total	Long	20	当前账号下的可用模板总数量。
Elements	Array of Elements		模板列表。
CreateTime	String	2021-01-29 10:19:05	模板创建时间。
UpdateTime	String	2021-01-29 10:19:05	模板更新时间。
UserId	String	zhangsan	用户ID。
TemplateId	String	6cd509ea-54fa-4730-8e9d-c94cadcda048	模板ID。
TemplateURL	String	http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/facebody/MergeImageFace/MergeImageFace-1.png	新增模板时设置的人脸模板图像地址。
FaceInfos	Array of FaceInfos		用户输入图为多个人脸时，返回各人脸ID和位置信息。
TemplateFaceID	String	6cd509ea-54fa-4730-8e9d-c94cadcda048	人脸对应的子模板ID。
FaceRect	Object		人脸对应的位置信息。
X	String	254	人脸框左上角横坐标。
Y	String	318	人脸框左上角纵坐标。
Height	String	94	人脸框高度。
Width	String	89	人脸框宽度。

SDK参考

阿里云视觉AI人脸人体类目下的图像人脸融合模板查询能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为人脸人体（facebody）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例

请求示例

http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=QueryFaceImageTemplate    //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&TemplateId=6cd509ea-54fa-4730-8e9d-c94cadcda048
&PageNo=1
&PageSize=100
&公共请求参数

请求示例补充说明

//当输入的人脸模板为多人脸场景时，请求示例如下：
http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=QueryFaceImageTemplate    //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&TemplateId=ef1197d4-ff61-4ba3-8cbd-72a17fbe3560
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryFaceImageTemplateResponse>
    <RequestId>7C29675C-751F-4D2F-86FB-2BD8D69AC860</RequestId>
    <Data>
        <Total>20</Total>
        <Elements>
            <CreateTime>2021-01-29 10:19:05</CreateTime>
            <UpdateTime>2021-01-29 10:19:05</UpdateTime>
            <UserId>zhangsan</UserId>
            <TemplateId>6cd509ea-54fa-4730-8e9d-c94cadcda048</TemplateId>
            <TemplateURL>http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/facebody/MergeImageFace/MergeImageFace-1.png</TemplateURL>
            <FaceInfos>
                <TemplateFaceID>6cd509ea-54fa-4730-8e9d-c94cadcda048</TemplateFaceID>
                <FaceRect>
                    <X>254</X>
                    <Y>318</Y>
                    <Height>94</Height>
                    <Width>89</Width>
                </FaceRect>
            </FaceInfos>
        </Elements>
    </Data>
</QueryFaceImageTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7C29675C-751F-4D2F-86FB-2BD8D69AC860",
  "Data" : {
    "Total" : 20,
    "Elements" : [ {
      "CreateTime" : "2021-01-29 10:19:05",
      "UpdateTime" : "2021-01-29 10:19:05",
      "UserId" : "zhangsan",
      "TemplateId" : "6cd509ea-54fa-4730-8e9d-c94cadcda048",
      "TemplateURL" : "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/facebody/MergeImageFace/MergeImageFace-1.png",
      "FaceInfos" : [ {
        "TemplateFaceID" : "6cd509ea-54fa-4730-8e9d-c94cadcda048",
        "FaceRect" : {
          "X" : "254",
          "Y" : "318",
          "Height" : "94",
          "Width" : "89"
        }
      } ]
    } ]
  }
}

返回示例补充说明

//当输入的人脸模板为多人脸场景时，返回示例如下：
{
  "RequestId": "983E8770-CC6C-5CA9-ACE0-D9B10D966F0C",
  "Data": {
    "Elements": [
      {
        "TemplateURL": "http://vibktprfx-prod-prod-aic-gd-cn-shanghai.oss-cn-shanghai.aliyuncs.com/image-face-fusion/OriginUrl/user/2023-04-20/a73f83a8-704c-4aa4-9a8e-c75b6494c8b4?Expires=1681962159&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=5owNw3jqn0FX1sYIwmwYN4MHGm****",
        "UserId": "zhangsan",
        "CreateTime": "2023-04-20 11:00:44",
        "UpdateTime": "2023-04-20 11:00:44",
        "FaceInfos": [
          {
            "FaceRect": {
              "X": "421.4748",
              "Y": "91.21092",
              "Height": "109.89087",
              "Width": "102.43414"
            },
            "TemplateFaceID": "ef1197d4-ff61-4ba3-8cbd-72a17fbe3560_0"
          },
          {
            "FaceRect": {
              "X": "181.38963",
              "Y": "139.80676",
              "Height": "98.78714",
              "Width": "97.7758"
            },
            "TemplateFaceID": "ef1197d4-ff61-4ba3-8cbd-72a17fbe3560_1"
          },
          {
            "FaceRect": {
              "X": "655.54626",
              "Y": "144.6498",
              "Height": "94.08194",
              "Width": "99.913025"
            },
            "TemplateFaceID": "ef1197d4-ff61-4ba3-8cbd-72a17fbe3560_2"
          }
        ],
        "TemplateId": "ef1197d4-ff61-4ba3-8cbd-72a17fbe3560"
      }
    ]
  }
}

错误码

关于图像人脸融合模板查询的错误码，详情请参见常见错误码。

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。