UpdateImage - Image Search - Alibaba Cloud Documentation Center

This topic describes the syntax of the UpdateImage operation and provides examples of this operation. You can call this operation to update image information of an Image Search instance.

Usage notes

This operation updates image information of an Image Search instance based on product ID and image name.

Note

Limits are imposed on the instance creation time.
This operation is supported by instances that are created in the Singapore region after December 2021. This operation is not supported in other regions.
To learn more about Image Search, submit your questions on the pre-sales online consultation page or contact Alibaba Cloud in the DingTalk group (ID: 35035130) for technical support.

QPS limits

By default, the maximum number of queries supported by this operation is 20. In this case, the system can process up to 20 requests per second.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateImage	The operation that you want to perform. Set the value to UpdateImage.
InstanceName	String	Yes	demoinstance1	The name of the Image Search instance. The name can be up to 20 characters in length. If an Image Search instance is purchased, you can log on to the Image Search console to view the instance. If no Image Search instance is purchased, you must purchase an instance. For more information, see Activate Image Search and Create an Image Search instance. Note The instance name is not the instance ID.
ProductId	String	Yes	2092061_1	The ID of the product. The ID can be up to 256 characters in length. Note A product may have multiple images. Specify this parameter based on your business requirements, such as jacket 001 and pants 002.
PicName	String	Yes	namexxx.jpg	The name of the image. The name can be up to 256 characters in length. Note An image is uniquely identified by the values of the ProductId and PicName parameters. If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.
CustomContent	String	No	zidingyi	The user-defined content. The value can be up to 4,096 characters in length. Note This parameter is returned when you call SearchImageByPic. You can add text such as an image description.
IntAttr	Integer	No	2	The attribute, which is an integer. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
StrAttr	String	No	ss	The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
IntAttr2	Integer	No	20	The attribute, which is an integer. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
StrAttr2	String	No	test	The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
IntAttr3	Integer	No	33	The attribute, which is an integer. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
StrAttr3	String	No	ss	The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
IntAttr4	Integer	No	33	The attribute, which is an integer. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.
StrAttr4	String	No	ss	The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you configure this parameter, the response returns this parameter and its value.

Response parameters

Parameter	Type	Example	Description
Message	String	success	The returned message.
RequestId	String	E0845DE6-52AF-4B50-9F15-51ED4044E6AB	The request ID.
Code	Integer	0	The error code. A value of 0 indicates that the request was successful. Values other than 0 indicate that the request failed.
Success	Boolean	true	Indicates whether the request was successful.

Examples

Sample requests

{
        "InstanceName": "demoinstance",
        "PicName": "test",
        "CustomContent": "demo content",
        "ProductId": "test",
        "IntAttr": "0",
        "StrAttr": "demo str attr"
    }

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "B253A127-DF89-4DDC-A295-618DD22B00B2",
  "Success" : true,
  "Code" : 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	BadRequest	The request has invalid parameters.	One or more parameters are invalid.
400	InvalidInstance	The specified instance name is invalid.	The instance name is invalid.
400	NoCaretSeperator	The body content is missing the ^ separator.	Specific symbols are missing in the request body.
400	EmptyMeta	The body content has an empty meta field.	The request body contains an empty parameter.
400	InvalidMetaItem	The meta field is invalid.	A meta parameter is set to an invalid value.
400	NoPicList	The body content is missing the pic_list parameter.	The pic_list parameter is not specified.
400	InvalidPicList	The specified pic_list parameter is invalid.	The pic_list parameter is set to an invalid value.
400	NoSpecifiedPic	The content of an image is not specified in the HTTP POST body.	No image is specified.
400	InvalidCategory	The specified category is invalid.	The category ID is invalid.
400	OverflowMaxResultNum	The specified number of total results exceeds the maximum of 500.	The specified total number of entries to return exceeds the upper limit, which is 500.
400	OverflowMaxReturnNum	The specified number of results for each request exceeds the maximum of 100.	The specified number of entries to return for a single request exceeds the upper limit, which is 100.
400	InvalidIntAttr	The specified int_attr field is invalid.	The IntAttr parameter is invalid.
400	UnsupportedPicFormat	The specified image format is invalid.	The image format is invalid.
400	InvalidFilterClause	The specified filtering condition is invalid.	The filter condition is invalid.
400	InstanceOverQuota	The number of items exceeds the limit.	The number of images on the instance exceeds the upper limit.
400	IncorrectOrientation	The image contains incorrect rotation flags in the meta data.	The image carries unsupported rotation settings.
400	UnsupportedPicPixels	The specified pixels is not supported.	The specified image pixel value is not supported.
400	InvalidStrAttr	The specified parameter StrAttr is not valid.	The StrAttr parameter is invalid.
400	InvalidIntAttr4	The specified parameter IntAttr4 is not valid.	The IntAttr4 parameter is invalid.
400	InvalidIntAttr3	The specified parameter IntAttr3 is not valid.	The IntAttr3 parameter is invalid.
400	InvalidIntAttr2	The specified parameter IntAttr2 is not valid.	The IntAttr2 parameter is invalid.
400	InvalidIntAttr	The specified parameter IntAttr is not valid.	The IntAttr parameter is invalid.
400	InvalidStrAttr4	The specified parameter StrAttr4 is not valid.	The StrAttr4 parameter is invalid.
400	InvalidStrAttr3	The specified parameter StrAttr3 is not valid.	The StrAttr3 parameter is invalid.
400	InvalidStrAttr2	The specified parameter StrAttr2 is not valid.	The StrAttr2 parameter is invalid.
403	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
403	DeniedRequest	Your request was denied due to instance flow control.	Your request was denied due to throttling.
500	NetworkException	A network error occurred.	A network error has occurred.
500	UnsupportedInstanceType	The instance type is not supported.	The instance type is not supported.
500	UnsupportedOperationType	The specified action is not supported.	The specified operation is not supported.
500	AccessEngineFailed	An error occurred while accessing the search engine.	An error has occurred in the search engine.
500	InternalOssError	An internal OAS error occurred.	An internal algorithm error has occurred.
500	InternalSwiftError	An internal SWIFT error occurred.	An internal message queue error has occurred.
500	InternalTableStoreError	An internal Table Store error occurred.	An internal Tablestore error has occurred.

For more error codes, see Service error codes.

Error codes

For a list of error codes, see Service error codes.