Create an image library

更新时间:
复制 MD 格式

Call this operation to create a sample image library for image similarity searches.

Usage notes

API operation: /green/similarity/library/add

After you create a sample image library, you can manage its sample images by dimension.

Limits

  • An Alibaba Cloud account can have up to 10 image libraries, including the default system library.
  • Each image library can contain a maximum of 100,000 sample images.

QPS limits

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Request parameters

For more information about common request parameters, see Common parameters.

The request body is a JSON object. The following table describes the fields of the object.

NameTypeRequiredExampleDescription
nameStringYesxxxxThe name of the image library to create. The name must be unique within the same region. The name can be up to 64 characters long and can contain Chinese characters, letters, and underscores.

Response data

For more information about response parameters, see Response structure.

The data field in the response is a JSON array. Each element of the array contains the following fields.

NameTypeExampleDescription
codeInteger200

The returned HTTP status code.

For more information, see Common error codes.

msgStringOKThe response message for the request.
nameStringxxxxThe name of the image library.
createTimeInteger1614588092The UNIX timestamp when the image library was created.
imageCountInteger0The number of sample images in the library.
regionStringcn-shanghaiThe region where the image library is located.
requestIdString33921869-CF8A-4E62-8C31-44F37341FFC1The ID of the request.

Examples

Request example

http(s)://[Endpoint]/green/similarity/library/add
&<Common request parameters>
{
  "name": "xxxx"
}

Response example

{
  "msg": "OK", 
  "code": 200, 
  "requestId": "33921869-CF8A-4E62-8C31-44F37341FFC1",
  "name": "xxxx",
  "createTime":,
  "imageCount":0,
  "region":"cn-shanghai"
}