diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/imagesearch/2019-03-25/api-docs.php | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
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 | 1185 |
1 files changed, 1185 insertions, 0 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 new file mode 100644 index 0000000..f3dba48 --- /dev/null +++ b/data/en_us/imagesearch/2019-03-25/api-docs.php @@ -0,0 +1,1185 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'ImageSearch', + 'version' => '2019-03-25', + ], + 'directories' => [ + [ + 'id' => 64375, + 'title' => 'Search', + 'type' => 'directory', + 'children' => [ + 'SearchImage', + ], + ], + [ + 'id' => 64377, + 'title' => 'Management', + 'type' => 'directory', + 'children' => [ + 'AddImage', + 'DeleteImage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SearchImage' => [ + 'summary' => '检索图片', + 'path' => '/v2/image/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchF4L5JA', + ], + ], + 'parameters' => [ + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '88888888', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'phimagesearch', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'pro-goods-25376', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'goods-23312-1', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'iVBORw0KGgoAAAANSUhEUgAAAV8AAADwAQMAAACdRvVNAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAADUExURQAAAKd6PdoAAAABdFJOUyR85Ty3AAAAIUlEQVRo3u3BAQ0AAADCoPdPbQ8HFAAAAAAAAAAAAADPBiowAAGR02EbAAAAAElFTkSuQmCC', + 'maxLength' => 6000000, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SearchByPic', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '(int_attr >= 100000000 AND int_attr < 200000000 AND int_attr=100000252 AND str_attr=\\"87\\")', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'PicInfo' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 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 \\"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"}]', + ], + 'AddImage' => [ + 'summary' => '添加图片', + 'path' => '/v2/image/add', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREimagesearchAOOGRD', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'demoinstance1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '88888888', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1', + ], + ], + [ + 'name' => 'PicName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2092061_1.jpg', + ], + ], + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=', + 'maxLength' => 6000000, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'CustomContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"merchant_id\\":\\"46-718f-da04-4099b2f144ae\\",\\"category_ids\\":[\\"1234\\"],\\"image_index\\":0,\\"updated\\":5678}', + ], + ], + [ + 'name' => 'IntAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'StrAttr', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E0845DE6-52AF-4B50-9F15-51ED4044E6AB', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '94,691,206,650', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + ], + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 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' => [], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + 409 => [ + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + ], + 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.', + ], + ], + ], + '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', + ], + ], +]; |
