Query information about a specific image library

更新时间:
复制 MD 格式

Call this API operation to query information about a specific image library.

Usage notes

API operation: /green/similarity/library/get

You can call this API operation to query information about a specific image library. For more information about how to structure an HTTP request, see Request structure. You can also use a pre-built HTTP request. For more information, see SDK overview.

QPS limits

You can call this operation up to 20 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.

NameTypeRequiredExampleDescription
nameStringYesxxxxThe name of the image library to query.

Response data

For more information about the response parameters, see Response parameters.

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

NameTypeExampleDescription
codeInteger200

The returned HTTP status code.

For more information, see Common error codes.

msgStringOKThe response message for the request.
namenamexxxxThe name of the image library.
createTimeIntegerxxxThe timestamp when the image library was created.
imageCountInteger0The number of samples in the image 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/get
&<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"
}