diff options
Diffstat (limited to 'data/en_us/imagesearch/2019-03-25/api-docs.php')
| -rw-r--r-- | data/en_us/imagesearch/2019-03-25/api-docs.php | 1650 |
1 files changed, 645 insertions, 1005 deletions
diff --git a/data/en_us/imagesearch/2019-03-25/api-docs.php b/data/en_us/imagesearch/2019-03-25/api-docs.php index f3dba48..a28551a 100644 --- a/data/en_us/imagesearch/2019-03-25/api-docs.php +++ b/data/en_us/imagesearch/2019-03-25/api-docs.php @@ -1,172 +1,127 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ImageSearch', - 'version' => '2019-03-25', - ], + 'info' => ['style' => 'ROA', 'product' => 'ImageSearch', 'version' => '2019-03-25'], 'directories' => [ [ - 'id' => 64375, - 'title' => 'Search', + 'children' => ['SearchImage'], 'type' => 'directory', - 'children' => [ - 'SearchImage', - ], + 'title' => 'Search', ], [ - 'id' => 64377, - 'title' => 'Management', + 'children' => ['AddImage', 'DeleteImage'], 'type' => 'directory', - 'children' => [ - 'AddImage', - 'DeleteImage', - ], + 'title' => 'Management', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'SearchImage' => [ - 'summary' => '检索图片', - 'path' => '/v2/image/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddImage' => [ + 'summary' => 'Describes the syntax and provides examples of the AddImage operation, which adds image information to an Image Search instance.', + 'path' => '/v2/image/add', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchF4L5JA', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchAOOGRD'], ], 'parameters' => [ [ - 'name' => 'CategoryId', + 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '88888888', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, refer to [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure you distinguish between the two.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'CategoryId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'phimagesearch', - ], + 'schema' => ['description' => 'The product category of the image. For more information, refer to [Category reference](~~179184~~).'."\n" + .'> - For product image search, if you specify a category, the specified category is used. If you do not specify a category, the system predicts the category. You can obtain the predicted category from the response.'."\n" + .'<props="china">'."\n" + .'- For fabric, trademark, generic, home furnishing, and industrial hardware searches, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>'."\n" + .'- For generic image search, the system sets the category to 88888888 regardless of whether you specify a category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '88888888', 'title' => ''], ], [ 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'pro-goods-25376', - ], + 'schema' => ['description' => 'The product ID. The ID can be up to 512 characters in length.'."\n" + ."\n" + .'>A product can have multiple images.', 'type' => 'string', 'required' => true, 'example' => '2092061_1', 'title' => ''], ], [ 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'goods-23312-1', - ], + 'schema' => ['description' => 'The image name. The name can be up to 512 characters in length.'."\n" + .'> - The combination of ProductId and PicName uniquely identifies an image.'."\n" + .'- If you add multiple images with the same ProductId and PicName, the last added image overwrites the previous ones.', 'type' => 'string', 'required' => true, 'example' => '2092061_1.jpg', 'title' => ''], ], [ 'name' => 'PicContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAV8AAADwAQMAAACdRvVNAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAADUExURQAAAKd6PdoAAAABdFJOUyR85Ty3AAAAIUlEQVRo3u3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAADPBiowAAGR02EbAAAAAElFTkSuQmCC', - 'maxLength' => 6000000, - ], + 'schema' => ['description' => 'The image content, which is Base64-encoded.'."\n" + ."\n" + .' - The image size cannot exceed 4 MB.'."\n" + .' - Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .' - The transmission wait time cannot exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .' - For product image search and generic image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .' - For trademark image search, the image width and height must be at least 200 pixels and less than 4,096 pixels.'."\n" + .' - For fabric image search, the image width and height must be at least 448 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For product image search and generic image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .' - The image cannot contain rotation information.', 'type' => 'string', 'required' => true, 'maxLength' => 6000000, 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to perform subject identification. Default value: true.'."\n" + .' - true: The system performs subject identification and searches based on the identified subject. You can obtain the subject identification result from the response.'."\n" + .'- false: The system does not perform subject identification and searches based on the entire image.'."\n" + ."\n" + .'<props="china">For fabric image search, this parameter is ignored and the system searches based on the entire image.</props>.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '32,282,43,256', - ], - ], - [ - 'name' => 'Num', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The subject region of the image, in the format of `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point.'."\n" + .'<props="china">'."\n" + .'> - If you specify Region, the system searches based on the specified region regardless of the value of the Crop parameter.'."\n" + .'- For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .'> For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>.', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351', 'title' => ''], ], [ - 'name' => 'Start', + 'name' => 'CustomContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The custom content. The content can be up to 4,096 characters in length.'."\n" + .'>This field is returned in query results. For example, you can add a text description of the image.', 'type' => 'string', 'required' => false, 'example' => '{\\"merchant_id\\":\\"46-718f-da04-4099b2f144ae\\",\\"category_ids\\":[\\"1234\\"],\\"image_index\\":0,\\"updated\\":5678}', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'IntAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SearchByPic', - ], + 'schema' => ['description' => 'The integer attribute. This attribute can be used to filter results during queries. This field is returned in query results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'StrAttr', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '(int_attr >= 100000000 AND int_attr < 200000000 AND int_attr=100000252 AND str_attr=\\"87\\")', - ], + 'schema' => ['description' => 'The string attribute. The attribute can be up to 128 characters in length. This attribute can be used to filter results during queries. This field is returned in query results.', 'type' => 'string', 'required' => false, 'example' => 'ss', 'title' => ''], ], ], 'responses' => [ @@ -174,485 +129,358 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Msg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - 'required' => false, - 'default' => 'success', - ], - 'Head' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DocsFound' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DocsReturn' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'SearchTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '95', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3033A0A7-36DA-5AC9-9973-953C38EBDFA9', - ], - 'Auctions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PicName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2092061_1.jpg', - ], - 'IntAttr' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CategoryId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8888888', - ], - 'ProductId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2092061_1', - ], - 'StrAttr' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ss', - ], - 'SortExprValues' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.37633353624177e+24;0', - ], - 'CustomContent' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zidingyi', - ], - 'Score' => [ - 'type' => 'number', - 'format' => 'float', - ], - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', 'title' => ''], + 'Code' => ['description' => 'The error code.'."\n" + ."\n" + .'- 0: success.'."\n" + .'- Non-zero: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'PicInfo' => [ - 'description' => '', + 'description' => 'The information such as category prediction and subject identification results.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => '94,691,206,650', - ], - 'CategoryId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], - 'MultiRegion' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'type' => 'string', - ], - ], - ], - ], - 'AllCategories' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'other', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', - ], - ], - ], - ], + 'Region' => ['description' => 'The subject identification result. The subject region of the image, in the format of `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point. If you specified the subject region in the request, the specified region is used.', 'type' => 'string', 'example' => '94,691,206,650', 'title' => ''], + 'CategoryId' => ['description' => 'The category prediction result. If you specified a category in the request, the specified category is used.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter start is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter num is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'title' => 'Add image data', + 'description' => '### Operation description'."\n" + .'This operation adds image information to an Image Search instance.'."\n" + ."\n" + .'### QPS limit'."\n" + .'An instance with a maximum image capacity of 100,000 has a default concurrency of 1, which means that a maximum of 1 image addition request can be processed per second.'."\n" + ."\n" + .'Instances with other maximum image capacities have a default concurrency of 5, which means that a maximum of 5 image addition requests can be processed per second.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"3033A0A7-36DA-5AC9-9973-953C38EBDFA9\\",\\n \\"Auctions\\": [\\n {\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"IntAttr\\": 2,\\n \\"CategoryId\\": 8888888,\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"StrAttr\\": \\"ss\\",\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 0\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888\\n },\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'AddImage' => [ - 'summary' => '添加图片', - 'path' => '/v2/image/add', - 'methods' => [ - 'post', + 'DeleteImage' => [ + 'path' => '/v2/image/delete', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + ."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com) to view the instance name.'."\n" + ."\n" + .'If you have not purchased an Image Search instance, refer to the topics about activating the service and creating an instance.'."\n" + ."\n" + .'> The instance name is not the instance ID. Make sure that you can distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'demoinstance1', 'title' => ''], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => ['description' => 'The product ID. The ID can be up to 512 characters in length.'."\n" + ."\n" + .'> A product can have multiple images.', 'type' => 'string', 'required' => true, 'example' => '179443', 'title' => ''], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => ['description' => 'The image name. The name can be up to 512 characters in length.'."\n" + .'> - The combination of ProductId and PicName uniquely identifies an image.'."\n" + .'- If you add images with the same ProductId and PicName multiple times, the last added image prevails and the previously added images are overwritten.', 'type' => 'string', 'required' => false, 'example' => '2092061_1.jpg', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', 'title' => ''], + 'Code' => ['description' => 'The error code. Valid values:'."\n" + .'- 0: success.'."\n" + .'- Non-zero value: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter s is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter n is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], + ], + 409 => [ + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], + ], + ], + 'title' => 'Delete an image', + 'summary' => 'This topic describes the syntax and examples of the DeleteImage operation, which is used to delete image information from an Image Search instance.', + 'description' => '### Operation description'."\n" + .'This operation is used to delete image information from an Image Search instance.'."\n" + ."\n" + .'> If the specified image does not exist in the Image Search instance, this operation still returns a success response. You cannot use the response to determine whether the image exists.'."\n" + ."\n" + .'### QPS limit'."\n" + .'The default concurrency for delete operations is 20, which means a maximum of 20 delete requests can be processed per second.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SearchImage' => [ + 'summary' => 'This topic describes the syntax and examples of the searchbyimage operation for online calls to the Taobao Alliance edition.', + 'path' => '/v2/image/search', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREimagesearchAOOGRD', - ], + 'abilityTreeNodes' => ['FEATUREimagesearchF4L5JA'], ], 'parameters' => [ [ - 'name' => 'InstanceName', + 'name' => 'CategoryId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], + 'schema' => ['description' => 'The product category. For more information, see [Category reference](~~179184~~).'."\n" + .' - For product image search, if you specify a category, the specified category is used. If you do not specify a category, the system predicts the category. You can obtain the predicted category from the response.'."\n" + .'<props="china">'."\n" + .' - For fabric, trademark, general furniture and home, and industrial hardware searches, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For generic image search, the system sets the category to 88888888 regardless of whether you specify a category.'."\n" + .'</props>.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '88888888', 'title' => ''], ], [ - 'name' => 'CategoryId', + 'name' => 'InstanceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '88888888', - ], + 'schema' => ['description' => 'The name of the Image Search instance. The name can be up to 20 characters in length.'."\n" + .'If you have purchased an Image Search instance, log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance name.'."\n" + .'If you have not purchased an Image Search instance, see [Activate the service](~~179178~~) and [Create an instance](~~66569~~).'."\n" + .'>The instance name is not the instance ID. Make sure that you distinguish between them.', 'type' => 'string', 'required' => true, 'example' => 'phimagesearch', 'title' => ''], ], [ 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1', - ], + 'schema' => ['description' => 'The product ID. The ID can be up to 512 characters in length.'."\n" + ."\n" + .'>A product can have multiple images.', 'type' => 'string', 'required' => false, 'example' => 'pro-goods-25376', 'title' => ''], ], [ 'name' => 'PicName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2092061_1.jpg', - ], + 'schema' => ['description' => 'The image name. The name can be up to 512 characters in length.'."\n" + .'> - The combination of ProductId and PicName uniquely identifies an image.'."\n" + .'- If you add multiple images with the same ProductId and PicName, the last added image overwrites the previous ones.', 'type' => 'string', 'required' => false, 'example' => 'goods-23312-1', 'title' => ''], ], [ 'name' => 'PicContent', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', - 'maxLength' => 6000000, - ], + 'schema' => ['description' => 'The image content, which is Base64-encoded.'."\n" + ."\n" + .' - The image size cannot exceed 4 MB.'."\n" + .' - Image formats: PNG, JPG, JPEG, BMP, GIF, WEBP, TIFF, and PPM.'."\n" + .' - The transmission wait time cannot exceed 5 seconds.'."\n" + .'<props="china">'."\n" + .' - For product image search and generic image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .' - For trademark image search, the image width and height must be at least 200 pixels and less than 4,096 pixels.'."\n" + .' - For fabric image search, the image width and height must be at least 448 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .'<props="intl">'."\n" + .' - For product image search and generic image search, the image width and height must be at least 100 pixels and at most 4,096 pixels.'."\n" + .'</props>'."\n" + .' - The image must not contain rotation information.', 'type' => 'string', 'required' => false, 'maxLength' => 6000000, 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAV8AAADwAQMAAACdRvVNAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAADUExURQAAAKd6PdoAAAABdFJOUyR85Ty3AAAAIUlEQVRo3u3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAADPBiowAAGR02EbAAAAAElFTkSuQmCC', 'title' => ''], ], [ 'name' => 'Crop', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to perform subject identification. Default value: true.'."\n" + .' - If this parameter is set to true, the system performs subject identification and searches based on the identified subject. You can obtain the subject identification result from the response.'."\n" + .' - If this parameter is set to false, the system does not perform subject identification and searches based on the entire image.'."\n" + .'<props="china">'."\n" + .'- For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '280,486,232,351', - ], + 'schema' => ['description' => 'The subject region of the image. Format: `x1,x2,y1,y2`, where `x1,y1` is the upper-left point and `x2,y2` is the lower-right point.'."\n" + .'<props="china">'."\n" + .'> - If you specify Region, the system searches based on the specified region regardless of the value of the Crop parameter.'."\n" + .'- For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + .'> For fabric image search, this parameter is ignored and the system searches based on the entire image.'."\n" + .'</props>.', 'type' => 'string', 'required' => false, 'example' => '32,282,43,256', 'title' => ''], ], [ - 'name' => 'CustomContent', + 'name' => 'Num', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"merchant_id\\":\\"46-718f-da04-4099b2f144ae\\",\\"category_ids\\":[\\"1234\\"],\\"image_index\\":0,\\"updated\\":5678}', - ], + 'schema' => ['description' => 'The number of results to return. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IntAttr', + 'name' => 'Start', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], + 'schema' => ['description' => 'The start position of the results to return. Valid values: 0 to 499. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'StrAttr', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ss', - ], + 'schema' => ['description' => 'The search type. Valid values:'."\n" + .'- SearchByPic (default): searches for similar images by image.'."\n" + .'- SearchByName: searches for similar images by the name of an image that has been added.', 'type' => 'string', 'required' => false, 'example' => 'SearchByPic', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition. The int_attr field supports the following operators: greater than (>), greater than or equal to (>=), less than (<), less than or equal to (<=), and equal to (=). The str_attr field supports the equal to (=) and not equal to (!=) operators. Multiple conditions can be connected by using AND or OR.'."\n" + .'Examples:'."\n" + .'- int_attr >= 100.'."\n" + .'- str_attr != "value1".'."\n" + .'- int_attr = 1000 AND str_attr = "value1".', 'type' => 'string', 'required' => false, 'example' => '(int_attr >= 100000000 AND int_attr < 200000000 AND int_attr=100000252 AND str_attr=\\"87\\")', 'title' => ''], ], ], 'responses' => [ @@ -660,526 +488,338 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', + 'Msg' => ['description' => 'The error message.', 'type' => 'string', 'required' => false, 'default' => 'success', 'example' => 'success', 'title' => ''], + 'Head' => [ + 'description' => 'The overview of the search results.', + 'type' => 'object', + 'properties' => [ + 'DocsFound' => ['description' => 'The number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DocsReturn' => ['description' => 'The number of matched results in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'SearchTime' => ['description' => 'The search duration, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '95', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3033A0A7-36DA-5AC9-9973-953C38EBDFA9', 'title' => ''], + 'Auctions' => [ + 'description' => 'The descriptions of all returned products.', + 'type' => 'array', + 'items' => [ + 'description' => 'The descriptions of all returned products.', + 'type' => 'object', + 'properties' => [ + 'PicName' => ['description' => 'The image name.', 'type' => 'string', 'example' => '2092061_1.jpg', 'title' => ''], + 'IntAttr' => ['description' => 'The integer attribute.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CategoryId' => ['description' => 'The image category.', 'type' => 'integer', 'format' => 'int32', 'example' => '8888888', 'title' => ''], + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '2092061_1', 'title' => ''], + 'StrAttr' => ['description' => 'The string attribute.', 'type' => 'string', 'example' => 'ss', 'title' => ''], + 'SortExprValues' => ['description' => 'The system scoring information.'."\n" + .'> - This field is deprecated. Use Score instead. '."\n" + .'- SortExprValues is a semicolon-separated tuple. The first value indicates the relevance score of the image. A higher value indicates higher relevance to the query image. The scoring varies depending on the algorithm model.'."\n" + .'- When the category is 0 to 2, the value range of SortExprValues is 0 to 7.33136443711219e+24.'."\n" + .'- For other category values, the value range of SortExprValues is 0 to 5.37633353624177e+24. This score reaches its maximum when two images are identical.', 'type' => 'string', 'example' => '5.37633353624177e+24;0', 'title' => ''], + 'CustomContent' => ['description' => 'The user-defined content.', 'type' => 'string', 'example' => 'zidingyi', 'title' => ''], + 'Score' => ['type' => 'number', 'format' => 'float', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.'."\n" + .'- 0: success.'."\n" + .'- Non-zero: failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'PicInfo' => [ - 'description' => '', + 'description' => 'The information such as category prediction and subject identification results.', 'type' => 'object', 'properties' => [ - 'Region' => [ + 'Region' => ['description' => 'The subject identification result.'."\n" + .'The subject region of the image. Format: x1,x2,y1,y2, where x1,y1 is the upper-left point and x2,y2 is the lower-right point. If the subject region is specified in the request, the value specified in the request takes precedence.', 'type' => 'string', 'example' => '94,691,206,650', 'title' => ''], + 'CategoryId' => ['description' => 'The category prediction result.'."\n" + .'If a category is specified in the request, the value specified in the request takes precedence.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + 'MultiRegion' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Region' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => '94,691,206,650', + 'title' => '', + 'example' => '', ], - 'CategoryId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '88888888', + 'AllCategories' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about all categories supported by the system.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The category name.', 'type' => 'string', 'example' => 'other', 'title' => ''], + 'Id' => ['description' => 'The category ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - [ - 'errorCode' => 'PicNotExist', - 'errorMessage' => 'The search picture does not exist.', - ], - [ - 'errorCode' => 'NoSpecifiedProductId', - 'errorMessage' => 'The parameter ProductId no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicName', - 'errorMessage' => 'The parameter PicName no specified.', - ], - [ - 'errorCode' => 'NoSpecifiedPicContent', - 'errorMessage' => 'The parameter PicContent no specified.', - ], - [ - 'errorCode' => 'InvalidType', - 'errorMessage' => 'The specified parameter Type is not valid.', - ], - [ - 'errorCode' => 'InvalidProductId', - 'errorMessage' => 'The specified parameter ProductId is not valid.', - ], - [ - 'errorCode' => 'InvalidPicName', - 'errorMessage' => 'The specified parameter PicName is not valid.', - ], - [ - 'errorCode' => 'InvalidStrAttr', - 'errorMessage' => 'The specified parameter StrAttr is not valid.', - ], - [ - 'errorCode' => 'InvalidCustomContent', - 'errorMessage' => 'The specified parameter CustomContent is not valid.', - ], - [ - 'errorCode' => 'InvalidPicContent', - 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', - ], - [ - 'errorCode' => 'TimeoutForTransferImage', - 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', - ], + ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''], + ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => ''], + ['errorCode' => 'NoCaretSeperator', 'errorMessage' => 'The body content is missing the ^ separator.', 'description' => ''], + ['errorCode' => 'EmptyMeta', 'errorMessage' => 'The body content has an empty meta field.', 'description' => ''], + ['errorCode' => 'InvalidMetaItem', 'errorMessage' => 'The meta field is invalid.', 'description' => ''], + ['errorCode' => 'NoPicList', 'errorMessage' => 'The body content is missing the pic_list parameter.', 'description' => ''], + ['errorCode' => 'InvalidPicList', 'errorMessage' => 'The specified pic_list parameter is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPic', 'errorMessage' => 'he content of an image is not specified in the HTTP POST body.', 'description' => ''], + ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''], + ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => ''], + ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => ''], + ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => ''], + ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''], + ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => ''], + ['errorCode' => 'NoSpecifiedAddPic', 'errorMessage' => 'The image to insert is not specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedItemId', 'errorMessage' => 'The item_id parameter is not specified.', 'description' => ''], + ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => ''], + ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => ''], + ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => ''], + ['errorCode' => 'InstanceOverQuota', 'errorMessage' => 'The number of items exceeds the limit.', 'description' => ''], + ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => ''], + ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => ''], + ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''], + ['errorCode' => 'PicNotExist', 'errorMessage' => 'The search picture does not exist.', 'description' => ''], + ['errorCode' => 'NoSpecifiedProductId', 'errorMessage' => 'The parameter ProductId no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicName', 'errorMessage' => 'The parameter PicName no specified.', 'description' => ''], + ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''], + ['errorCode' => 'InvalidType', 'errorMessage' => 'The specified parameter Type is not valid.', 'description' => ''], + ['errorCode' => 'InvalidProductId', 'errorMessage' => 'The specified parameter ProductId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicName', 'errorMessage' => 'The specified parameter PicName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidStrAttr', 'errorMessage' => 'The specified parameter StrAttr is not valid.', 'description' => 'Invalid StrAttr'], + ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''], + ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => ''], + ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => ''], ], 409 => [ - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', - ], + ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UnknownException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E0845DE6-52AF-4B50-9F15-51ED4044E6AB\\",\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888\\n },\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'DeleteImage' => [ - 'path' => '/v2/image/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => ''], + ['errorCode' => 'RequestTimeout', 'errorMessage' => 'The request is timeout.', 'description' => ''], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'The instance type is not supported.', 'description' => ''], + ['errorCode' => 'UnsupportedOperationType', 'errorMessage' => 'The specified action is not supported.', 'description' => ''], + ['errorCode' => 'ExtractFeatureTimeout', 'errorMessage' => 'The request was timed out while extracting features.', 'description' => ''], + ['errorCode' => 'AccessEngineFailed', 'errorMessage' => 'An error occurred while accessing the search engine.', 'description' => ''], + ['errorCode' => 'InternalOssError', 'errorMessage' => 'An internal OAS error occurred.', 'description' => ''], + ['errorCode' => 'InternalSwiftError', 'errorMessage' => 'An internal SWIFT error occurred.', 'description' => ''], + ['errorCode' => 'InternalTableStoreError', 'errorMessage' => 'An internal Table Store error occurred.', 'description' => ''], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'InstanceName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'demoinstance1', - ], - ], - [ - 'name' => 'ProductId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '179443', - ], - ], + 'title' => 'Search by image', + 'description' => '### QPS limit'."\n" + .'You can view the default maximum access frequency for query operations in the console. The frequency is the queries per second (QPS) value that you selected at the time of purchase. Valid values: 1, 5, and 10.'."\n" + ."\n" + .'### SDK version description'."\n" + .'After you upgrade the Image Search SDK to V3.1.1, you can use the multi-subject identification and similarity score features. For more information, see [Java SDK](~~179188~~).', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'PicName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2092061_1.jpg', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0703956F-9BCC-48FA-99F7-96C0BF449C69', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BadRequest', - 'errorMessage' => 'The request has invalid parameters.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The specified instance name is invalid.', - ], - [ - 'errorCode' => 'NoCaretSeperator', - 'errorMessage' => 'The body content is missing the ^ separator.', - ], - [ - 'errorCode' => 'EmptyMeta', - 'errorMessage' => 'The body content has an empty meta field.', - ], - [ - 'errorCode' => 'InvalidMetaItem', - 'errorMessage' => 'The meta field is invalid.', - ], - [ - 'errorCode' => 'NoPicList', - 'errorMessage' => 'The body content is missing the pic_list parameter.', - ], - [ - 'errorCode' => 'InvalidPicList', - 'errorMessage' => 'The specified pic_list parameter is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedPic', - 'errorMessage' => 'The content of an image is not specified in the HTTP POST body.', - ], - [ - 'errorCode' => 'NoSpecifiedSearchPic', - 'errorMessage' => 'The search image is not specified.', - ], - [ - 'errorCode' => 'InvalidCategory', - 'errorMessage' => 'The specified category is invalid.', - ], - [ - 'errorCode' => 'OverflowMaxResultNum', - 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', - ], - [ - 'errorCode' => 'OverflowMaxReturnNum', - 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', - ], - [ - 'errorCode' => 'InvalidStartParameter', - 'errorMessage' => 'The specified parameter s is inavlid.', - ], - [ - 'errorCode' => 'InvalidNumParameter', - 'errorMessage' => 'The specified parameter n is invalid.', - ], - [ - 'errorCode' => 'NoSpecifiedAddPic', - 'errorMessage' => 'The image to insert is not specified.', - ], - [ - 'errorCode' => 'NoSpecifiedItemId', - 'errorMessage' => 'The item_id parameter is not specified.', - ], - [ - 'errorCode' => 'InvalidIntAttr', - 'errorMessage' => 'The specified int_attr field is invalid.', - ], - [ - 'errorCode' => 'UnsupportedPicFormat', - 'errorMessage' => 'The specified image format is invalid.', - ], - [ - 'errorCode' => 'InvalidFilterClause', - 'errorMessage' => 'The specified filtering condition is invalid.', - ], - [ - 'errorCode' => 'InstanceOverQuota', - 'errorMessage' => 'The number of items exceeds the limit.', - ], - [ - 'errorCode' => 'IncorrectOrientation', - 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', - ], - [ - 'errorCode' => 'UnsupportedPicPixels', - 'errorMessage' => 'The specified pixels is not supported.', - ], - [ - 'errorCode' => 'SearchTimeout', - 'errorMessage' => 'The request is timed out.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation.', - ], - [ - 'errorCode' => 'DeniedRequest', - 'errorMessage' => 'Your request was denied due to instance flow control.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Head\\": {\\n \\"DocsFound\\": 10,\\n \\"DocsReturn\\": 10000,\\n \\"SearchTime\\": 95\\n },\\n \\"RequestId\\": \\"3033A0A7-36DA-5AC9-9973-953C38EBDFA9\\",\\n \\"Auctions\\": [\\n {\\n \\"PicName\\": \\"2092061_1.jpg\\",\\n \\"IntAttr\\": 2,\\n \\"CategoryId\\": 8888888,\\n \\"ProductId\\": \\"2092061_1\\",\\n \\"StrAttr\\": \\"ss\\",\\n \\"SortExprValues\\": \\"5.37633353624177e+24;0\\",\\n \\"CustomContent\\": \\"zidingyi\\",\\n \\"Score\\": 0\\n }\\n ],\\n \\"Code\\": 0,\\n \\"PicInfo\\": {\\n \\"Region\\": \\"94,691,206,650\\",\\n \\"CategoryId\\": 88888888,\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"\\"\\n }\\n ],\\n \\"AllCategories\\": [\\n {\\n \\"Name\\": \\"other\\",\\n \\"Id\\": 88888888\\n }\\n ]\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-beijing.aliyuncs.com', 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'imagesearch.eu-central-1.aliyuncs.com', 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'imagesearch.ap-south-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-south-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessEngineFailed', 'message' => 'An error occurred while accessing the search engine.', 'http_code' => 400, 'description' => ''], + ['code' => 'ConnectionDVException', 'message' => 'Failed to obtain collection.', 'http_code' => 500, 'description' => 'internalError'], + ['code' => 'Console.BadRequest', 'message' => 'The request has invalid parameters.', 'http_code' => 400, 'description' => 'Invalid request. Check the request parameters.'], + ['code' => 'Console.CallServiceError', 'message' => 'An internal service error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'Console.InstanceNotFound', 'message' => 'The specified ImageSearch instance is not found.', 'http_code' => 400, 'description' => 'The specified instance ID does not exist. Check the instance ID and try again.'], + ['code' => 'Console.InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 409, 'description' => 'Instance status error, please check the instance status'], + ['code' => 'Console.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'The server has an internal error. Log on to the Alibaba Cloud console to submit a ticket.'], + ['code' => 'Console.LoginError', 'message' => 'Check login failed.', 'http_code' => 401, 'description' => 'Login failed, please check whether the user name, password and email address are entered incorrectly.'], + ['code' => 'Console.MigrateCapacityError', 'message' => 'Migration instance specification error.', 'http_code' => 400, 'description' => 'The specification of the target instance to be migrated is incorrect. The specification of the target instance must be greater than or equal to the specification of the source instance.'], + ['code' => 'Console.MigrateDocNumError', 'message' => 'Migration target instance doc quantity error.', 'http_code' => 400, 'description' => 'The number of docs for the target instance must be 0.'], + ['code' => 'Console.MigrateError', 'message' => 'An instance can only have one migration task.', 'http_code' => 400, 'description' => 'An instance can only have one migration task.'], + ['code' => 'Console.MigrateExistError', 'message' => 'Only one migration task can exist in an instance.', 'http_code' => 400, 'description' => 'Only one migration task can exist in the current instance.'], + ['code' => 'Console.MigrateTypeError', 'message' => 'Migration instance type error.', 'http_code' => 400, 'description' => 'Both instances must be of the same type.'], + ['code' => 'Console.ModifyTokenTimesExceed', 'message' => 'You can only modify the token once every day.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.NoPermissionError', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'Console.NotAllowedModifyToken', 'message' => 'You are not allowed to modify token today.', 'http_code' => 403, 'description' => ''], + ['code' => 'Console.OrderStatusError', 'message' => 'Current Order status not supported this opreate.', 'http_code' => 409, 'description' => 'User order error, please confirm that the order is valid'], + ['code' => 'Console.PidDescError', 'message' => 'The maximum character length of this PidDesc parameter is 32.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.PidError', 'message' => 'The number of PID bindings of the current instance exceeds 50.', 'http_code' => 400, 'description' => ''], + ['code' => 'Console.TaskAlreadyExist', 'message' => 'A task that is in progress already exists.', 'http_code' => 409, 'description' => ''], + ['code' => 'DeniedRequest', 'message' => 'Your request was denied due to instance flow control.', 'http_code' => 403, 'description' => ''], + ['code' => 'EmptyMeta', 'message' => 'The body content has an empty meta field.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExtractFeatureTimeout', 'message' => 'The request timed out while extracting features.', 'http_code' => 500, 'description' => ''], + ['code' => 'IncorrectOrientation', 'message' => 'The image contains incorrect rotation flags in the meta data.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceOverQuota', 'message' => 'The number of items exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalOssError', 'message' => 'An internal OAS error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalSwiftError', 'message' => 'An internal SWIFT error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalTableStoreError', 'message' => 'An internal Table Store error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidCategory', 'message' => 'The specified category is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCategoryId', 'message' => 'The specified CategoryId parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCrop', 'message' => 'The specified Crop parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCustomContent', 'message' => 'The specified CustomContent is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFilterClause', 'message' => 'The specified filtering condition is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidInstance', 'message' => 'The specified instance name is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidIntAttr', 'message' => 'The specified int_attr field is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidIntAttr', 'message' => 'The specified parameter IntAttr is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr'], + ['code' => 'InvalidIntAttr2', 'message' => 'The specified parameter IntAttr2 is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr2'], + ['code' => 'InvalidIntAttr3', 'message' => 'The specified parameter IntAttr3 is not valid.', 'http_code' => 400, 'description' => 'Invalid IntAttr3'], + ['code' => 'InvalidIntAttr4', 'message' => 'The specified parameter IntAttr4 is not valid.', 'http_code' => 400, 'description' => 'Invalid'], + ['code' => 'InvalidMetaItem', 'message' => 'The meta field is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNum', 'message' => 'The specified Num parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNumParameter', 'message' => 'The specified parameter num is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterReturnPicFormat', 'message' => 'The specified parameter returnPicFormat is invalid', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterReturnPicType', 'message' => 'The specified parameter returnPicType is invalid', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameterTitleIndex', 'message' => 'The specified parameter titleIndex is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicContent', 'message' => 'The image size exceeds 4 MB.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicList', 'message' => 'The specified pic_list parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicName', 'message' => 'The specified PicName is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPicUrl', 'message' => 'The specified parameter PicUrl is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPrimaryPicContent', 'message' => 'The specified parameter PrimaryPicContent is not valid.', 'http_code' => 400, 'description' => 'Invalid PrimaryPicContent parameter'], + ['code' => 'InvalidProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProductId', 'message' => 'The parameter ProductId no specified.', 'http_code' => 400, 'description' => 'Invalid ProductId'], + ['code' => 'InvalidSecondaryPicContent', 'message' => 'The specified parameter SecondaryPicContent is not valid.', 'http_code' => 400, 'description' => 'Invalid SecondaryPicContent parameter'], + ['code' => 'InvalidStart', 'message' => 'The specified Start parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStartParameter', 'message' => 'The specified parameter start is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrAttr', 'message' => 'The specified StrAttr is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrAttr', 'message' => 'The specified parameter StrAttr is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr'], + ['code' => 'InvalidStrAttr2', 'message' => 'The specified parameter StrAttr2 is not valid.', 'http_code' => 400, 'description' => 'Invalid'], + ['code' => 'InvalidStrAttr3', 'message' => 'The specified parameter StrAttr3 is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr3'], + ['code' => 'InvalidStrAttr4', 'message' => 'The specified parameter StrAttr4 is not valid.', 'http_code' => 400, 'description' => 'Invalid StrAttr4'], + ['code' => 'InvalidText', 'message' => 'The specified parameter Text is not valid.', 'http_code' => 400, 'description' => 'Description Text cannot be null'], + ['code' => 'InvalidTextLength', 'message' => 'Invalid text clause.', 'http_code' => 400, 'description' => 'The text field length must be within 512.'], + ['code' => 'InvalidType', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserType', 'message' => 'The specified UserType parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'NeedRegisterBeforeInvoke', 'message' => 'Register for PID before invoking the service.', 'http_code' => 400, 'description' => ''], + ['code' => 'NetworkException', 'message' => 'A network error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoCaretSeperator', 'message' => 'The body content is missing the ^ separator.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'NoPicList', 'message' => 'The body content is missing the pic_list parameter.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedAddPic', 'message' => 'You must specify an image.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedItemId', 'message' => 'You must specify item_id.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPic', 'message' => 'The content of an image is not specified in the HTTP POST body.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPicContent', 'message' => 'You must specify PicContent.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedPicName', 'message' => 'You must specify PicName.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedProductId', 'message' => 'You must specify ProductId.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoSpecifiedSearchPic', 'message' => 'You must specify a search image.', 'http_code' => 400, 'description' => ''], + ['code' => 'OverflowMaxResultNum', 'message' => 'The specified number of total results exceeds the maximum of 500.', 'http_code' => 400, 'description' => ''], + ['code' => 'OverflowMaxReturnNum', 'message' => 'The specified number of results for each request exceeds the maximum of 100.', 'http_code' => 400, 'description' => ''], + ['code' => 'PicNotExist', 'message' => 'The specified image does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 500, 'description' => 'Picture download failed, please check the picture'], + ['code' => 'PidNotExist', 'message' => 'The specified Pid parameter does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'RequestTimeout', 'message' => 'The request timed out.', 'http_code' => 500, 'description' => ''], + ['code' => 'SearchTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => ''], + ['code' => 'ServerInternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'TimeoutForTransferImage', 'message' => 'Image transfer timed out.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnknownException', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 500, 'description' => ''], + ['code' => 'UnsupportedPicCategory', 'message' => 'The picture category is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPicFormat', 'message' => 'The specified image format is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPicPixels', 'message' => 'The specified pixels is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedPictureFormat', 'message' => 'The format of the specified picture is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 400, 'description' => 'Picture download failed, please check the picture'], + ['code' => 'Console.OssError', 'message' => 'OSS information error.', 'http_code' => 400, 'description' => 'oss information error'], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'ImageSearch', + 'productName' => 'Image Search', + 'ramCodes' => ['imagesearch'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'SearchImage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'imagesearch:SearchImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 409 => [ - [ - 'errorCode' => 'InstanceStatusError', - 'errorMessage' => 'Your instance is unavailable.', + ], + [ + 'apiName' => 'AddImage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'imagesearch:AddImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'An internal server error occurred.', - ], - [ - 'errorCode' => 'NetworkException', - 'errorMessage' => 'A network error occurred.', - ], - [ - 'errorCode' => 'RequestTimeout', - 'errorMessage' => 'The request is timeout.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'The instance type is not supported.', - ], - [ - 'errorCode' => 'UnsupportedOperationType', - 'errorMessage' => 'The specified action is not supported.', - ], - [ - 'errorCode' => 'ExtractFeatureTimeout', - 'errorMessage' => 'The request was timed out while extracting features.', - ], - [ - 'errorCode' => 'AccessEngineFailed', - 'errorMessage' => 'An error occurred while accessing the search engine.', - ], - [ - 'errorCode' => 'InternalOssError', - 'errorMessage' => 'An internal OAS error occurred.', - ], - [ - 'errorCode' => 'InternalSwiftError', - 'errorMessage' => 'An internal SWIFT error occurred.', - ], - [ - 'errorCode' => 'InternalTableStoreError', - 'errorMessage' => 'An internal Table Store error occurred.', + ], + [ + 'apiName' => 'DeleteImage', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'imagesearch:DeleteImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0703956F-9BCC-48FA-99F7-96C0BF449C69\\",\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |