API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (ImageSearch/2020-12-14) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Management
|
API |
Title |
Description |
| AddImage | Add an image | Describes the syntax and provides examples of the AddImage operation, which adds image information to an Image Search instance. |
| DeleteImage | Delete an image | This topic describes the syntax and examples of the DeleteImage operation, which is used to delete image information from an Image Search instance. |
Search
|
API |
Title |
Description |
| SearchImageByName | Search images by name | This topic describes the syntax and examples of the SearchByName operation, which is used to query image information in an Image Search instance by name. |
| SearchImageByPic | Search by image | This topic describes the syntax and examples of SearchByPic, which is used to search for image information in an Image Search instance by image. |
Other
|
API |
Title |
Description |
| CompareSimilarByImage | Compare image similarity | Compares two images and returns a similarity score. |
| Detail | Query instance status | This topic describes the syntax and examples of the Detail operation, which queries information about an Image Search instance by name. |
| DumpMeta | Export metadata | This topic describes the syntax and examples of the DumpMeta operation, which creates a metadata export task for Image Search by name. |
| DumpMetaList | Query metadata export tasks | Describes the syntax and provides examples of the DumpMetaList operation, which queries the list of metadata export tasks in an Image Search instance. |
| IncreaseInstance | Batch operations | Describes the syntax and provides examples of the IncreaseInstance operation, which is used to create a batch task for an Image Search instance by name. |
| IncreaseList | List batch tasks | Queries the list of batch tasks in an Image Search instance by calling the IncreaseList operation. This topic describes the syntax and provides examples. |
| SearchImageByText | Search for images by text | This topic describes the syntax and examples of SearchImageByText, which is used to search for image information in an Image Search instance based on text. |
| UpdateImage | Update an image | This topic describes the syntax and examples of the UpdateImage operation, which modifies image information in an Image Search instance. |
| CheckImageExists | Check Image | CheckImageExists |