调用CreateCustomEntity创建相应自定义库中自定义实体。

使用说明

本接口目前支持的地域为华北2(北京)、华东2(上海)、华东1(杭州),其他地域暂不支持。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:CreateCustomEntity

Algorithm String landmark

自定义类型,取值:

  • landmark:自定义地标。
  • object:自定义物体。
CustomGroupId String 1

自定义库ID。

CustomEntityName String 自定义库实体名称

自定义库实体名称,最长支持64字节。

CustomEntityInfo String { "finegrainName":"examplName" }

自定义实体的额外信息,JSON String类型,最长支持256字节。

返回数据

名称 类型 示例值 描述
CustomEntityId String 1

自定义库实体ID。

RequestId String 580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5

请求ID,具有唯一性。

示例

请求示例

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=CreateCustomEntity
&Algorithm=landmark
&CustomGroupId=1
&CustomEntityName=自定义库实体名称
&CustomEntityInfo={ "finegrainName":"examplName" }
&<公共请求参数>

正常返回示例

XML格式

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

<CreateCustomEntityResponse>
    <CustomEntityId>1</CustomEntityId>
    <RequestId>580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5</RequestId>
</CreateCustomEntityResponse>

JSON格式

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

{
  "CustomEntityId" : "1",
  "RequestId" : "580e8ce3-3b80-44c5-9f3f-36ac3cc5bdd5"
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError errorMsg:%s 内部错误,偶发请重试。

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