UpdateFaceGroup - 更新媒体集中人脸分组

更新时间:
复制 MD 格式

更新媒体集中人脸分组的名称、封面图、标签等信息。

接口说明

此接口已不再维护,建议使用新版(2020-09-30 版本)接口 UpdateFigureCluster 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

说明

接口公测中,如有任何使用问题,请使用钉钉搜索钉钉群号 31690030817 加入钉钉群进行反馈。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Project

string

是

项目名称。

immimagetest

SetId

string

是

媒体集的唯一标识。

set001

GroupId

string

是

人脸分组的唯一标识。

Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09

GroupName

string

否

人脸分组名称。

mygroup

GroupCoverFaceId

string

否

人脸分组封面图的 FaceId,可以使用媒体集图片处理相关接口(例如 GetImage、ListImages 等)获得该 FaceId。

FaceId 必须为同一分组 (即 GroupId 相同)中的人脸 ID。

8ba3460c1dcaa81f53b56e30c69d46693db215cf19aa19265f979913c24c8ef1

RemarksA

string

否

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。

  • 作为客户端的相对路径存入,例如 nas://path/to/file。

remarksa11

RemarksB

string

否

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。

  • 作为客户端的相对路径存入,例如 nas://path/to/file。

remarksb11

RemarksC

string

否

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。

  • 作为客户端的相对路径存入,例如 nas://path/to/file。

remarksc11

RemarksD

string

否

标记信息,为使用者预留的筛选参数,用于记录所需要的信息。

在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。

  • 作为客户端的相对路径存入,例如 nas://path/to/file。

remarksd11

RemarksArrayA

string

否

标记信息列表,格式为数组。

["remarka11","remarka12"]

RemarksArrayB

string

否

标记信息列表,格式为数组。

["remarkb11","remarkb12"]

ExternalId

string

否

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

externalIdtest

ResetItems

string

否

可以将对应字段设置为空值,格式为数组。

数组内可用值有:

  • GroupName

  • RemarksA

  • RemarksB

  • RemarksC

  • RemarksD

  • RemarksArrayA

  • RemarksArrayB

  • ExternalId

["GroupName"]

返回参数

名称

类型

描述

示例值

object

RequestId

string

当次请求的 Request ID。

A1104C7E-AA5E-4D5F-8A00-6BFD608103D2

SetId

string

媒体集的唯一标识。

set001

GroupId

string

人脸分组的唯一标识。

Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09

示例

正常返回示例

JSON格式

{
  "RequestId": "A1104C7E-AA5E-4D5F-8A00-6BFD608103D2",
  "SetId": "set001",
  "GroupId": "Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。