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

说明 接口公测中,如有任何使用问题请 联系我们

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateFaceGroup

操作接口名称,系统规定参数,固定取值为UpdateFaceGroup。

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

人脸分组的唯一标识。

GroupName String mygroup

人脸分组名称。

Project String immimagetest

项目名称。

SetId String set001

媒体集的唯一标识。

RegionId String cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

GroupCoverFaceId String 8ba3460c1dcaa81f53b56e30c69d46693db215cf19aa19265f979913c24c8ef1

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

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

RemarksA String remarksa11

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

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

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

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

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

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

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

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

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

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

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

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

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

RemarksArrayB String ["remarkb11","remarkb12"]

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

ExternalId String externalIdtest

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

ResetItems String ["GroupName"]

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

数组内可用值有:

  • GroupName
  • RemarksA
  • RemarksB
  • RemarksC
  • RemarksD
  • RemarksArrayA
  • RemarksArrayB
  • ExternalId

返回数据

名称 类型 示例值 描述
GroupId String Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09

人脸分组的唯一标识。

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

当次请求的Request ID。

SetId String set001

媒体集的唯一标识。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateFaceGroup
&GroupId=Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09
&GroupName=mygroup
&Project=immimagetest
&SetId=set001
&<公共请求参数>

正常返回示例

XML格式

<RequestId>A1104C7E-AA5E-4D5F-8A00-6BFD608103D2</RequestId>
<SetId>set001</SetId>
<GroupId>Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09</GroupId>

JSON格式

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