注册自定义实体照片。
接口说明
本接口目前支持的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州),其他地域暂不支持。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mts:RegisterCustomView |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Algorithm | string | 是 | 自定义类型,取值:
| landmark |
CustomGroupId | string | 是 | 自定义库 ID。 | 1 |
CustomEntityId | string | 是 | 自定义库实体 ID。 | 2 |
ImageUrl | string | 是 | 图片 URL。 | http://127.66.**.**/image.jpeg |
返回参数
示例
正常返回示例
JSON
格式
{
"CustomViewId": "1",
"RequestId": "580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | errorMsg:%s | - |
500 | InternalError | errorMsg:%s | 内部错误,偶发请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-09-06 | 新增 OpenAPI | 查看变更详情 |