更新时间:2023-12-11 GMT+08:00

创建实例

功能介绍

创建实例,实例中会生成图片索引库,用来存放图片特征。

URI

POST /v1/{project_id}/service

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的项目ID。获取方法请参见获取项目ID和名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

实例名称。

  • 仅支持小写字母(a-z)、数字,横杠和下划线。
  • 以字母开头,长度在16位以内。

model

String

模型名称,支持的模型名称:common-search,通用图片搜索,适用于图片库中搜索相似内容或类别的图片。

description

String

对实例的描述。

level

Integer

规格,即实例的图片数量规格。默认为30000000(单位:张),当前仅支持默认规格。

缺省值:30000000

tags

Array of strings

图片自定义标签,每个实例最多支持10个标签,自定义标签不支持英文字母大写。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

domain

String

模型展示名或领域名称。

desc

String

服务实例描述。

registerDate

Long

注册时间。

expiredDate

Long

过期时间,-1表示永不过期。

level

Integer

规格,即实例的图片数量规格,默认为30000000(单位:张)。

tags

Array of strings

图片自定义标签。

status

String

实例的状态,有以下状态信息:

  • NORMAL:正常。
  • ARREARAGE:欠费。
  • CREATION:创建中。
  • CREATION_FAILD:创建失败。
  • DELETING:删除中。
  • DELETING_FAILED:删除失败。
  • ABNORMAL:异常。

instanceName

String

实例名称。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

创建实例,实例名称为test_instance,模型名称为通用图片搜索。

POST https://{endpoint}/v1/{project_id}/service

{
  "name" : "test_instance",
  "model" : "common-search",
  "description" : "register service for user model test.",
  "level" : 30000000,
  "tags" : [ "tag1", "tag2" ]
}

响应示例

状态码: 200

成功响应示例

{
  "instanceName" : "test_instance ",
  "level" : 30000000,
  "expiredDate" : -1,
  "domain" : "model description",
  "desc" : "register service for user model test.",
  "registerDate" : 1528203334203,
  "tags" : [ "tag1", "tag2" ],
  "status" : "NORMAL"
}

状态码: 400

失败响应示例

{
  "error_code" : "IS.3000",
  "error_msg" : "TInstance name is already exists."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码