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

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

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:UpdateFaceGroup
*全部资源
*

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immimagetest
SetIdstring

媒体集的唯一标识。

set001
GroupIdstring

人脸分组的唯一标识。

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

人脸分组名称。

mygroup
GroupCoverFaceIdstring

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

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

8ba3460c1dcaa81f53b56e30c69d46693db215cf19aa19265f979913c24c8ef1
RemarksAstring

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

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

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarksa11
RemarksBstring

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

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

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarksb11
RemarksCstring

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

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

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarksc11
RemarksDstring

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

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

  • 作为客户端权限字段存入,例如 AdminGroup/AdminUserA/,即可使用前缀过滤用户权限。
  • 作为客户端的相对路径存入,例如 nas://path/to/file。
remarksd11
RemarksArrayAstring

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

["remarka11","remarka12"]
RemarksArrayBstring

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

["remarkb11","remarkb12"]
ExternalIdstring

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

externalIdtest
ResetItemsstring

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

数组内可用值有:

  • GroupName
  • RemarksA
  • RemarksB
  • RemarksC
  • RemarksD
  • RemarksArrayA
  • RemarksArrayB
  • ExternalId
["GroupName"]

返回参数

名称类型描述示例值
object
RequestIdstring

当次请求的 Request ID。

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

媒体集的唯一标识。

set001
GroupIdstring

人脸分组的唯一标识。

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

示例

正常返回示例

JSON格式

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

错误码

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