CreateCustomEntity - 创建自定义实体

更新时间:2024-11-11 07:21:33

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

接口说明

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

自定义类型,取值:

  • landmark:自定义地标。

  • object:自定义物体。

landmark
CustomGroupIdstring

自定义库 ID。

1
CustomEntityNamestring

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

自定义库实体名称
CustomEntityInfostring

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

{ "finegrainName":"examplName" }

返回参数

名称类型描述示例值
名称类型描述示例值
object

返回参数。

CustomEntityIdstring

自定义库实体 ID。

1
RequestIdstring

请求 ID,具有唯一性。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InvalidParametererrorMsg:%s-
500InternalErrorerrorMsg:%s内部错误,偶发请重试。

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2022-09-06新增 OpenAPI查看变更详情
  • 本页导读 (1)
  • 接口说明
  • QPS 限制
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史