summaryrefslogtreecommitdiff
path: root/data/en_us/imgsearch/2020-03-20/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/imgsearch/2020-03-20/api-docs.php
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
Diffstat (limited to 'data/en_us/imgsearch/2020-03-20/api-docs.php')
-rw-r--r--data/en_us/imgsearch/2020-03-20/api-docs.php611
1 files changed, 611 insertions, 0 deletions
diff --git a/data/en_us/imgsearch/2020-03-20/api-docs.php b/data/en_us/imgsearch/2020-03-20/api-docs.php
new file mode 100644
index 0000000..64149ec
--- /dev/null
+++ b/data/en_us/imgsearch/2020-03-20/api-docs.php
@@ -0,0 +1,611 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'imgsearch',
+ 'version' => '2020-03-20',
+ ],
+ 'directories' => [
+ [
+ 'id' => 64439,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateImageDb',
+ 'ListImageDbs',
+ 'AddImage',
+ 'ListImages',
+ 'SearchImage',
+ 'DeleteImageDb',
+ 'DeleteImage',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'CreateImageDb' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => 'DD106AE3-838A-41D7-8CD0-B902DC2BC109',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DD106AE3-838A-41D7-8CD0-B902DC2BC109\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>DD106AE3-838A-41D7-8CD0-B902DC2BC109</RequestId>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'ListImageDbs' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '4E010B89-B370-458A-A586-B9A9F3BC3058',
+ 'type' => 'string',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'properties' => [
+ 'DbList' => [
+ 'description' => '',
+ 'items' => [
+ 'properties' => [
+ 'Name' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ 'type' => 'array',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E010B89-B370-458A-A586-B9A9F3BC3058\\",\\n \\"Data\\": {\\n \\"DbList\\": [\\n {\\n \\"Name\\": \\"default\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4E010B89-B370-458A-A586-B9A9F3BC3058</RequestId>\\n<Data>\\n <DbList>\\n <Name>default</Name>\\n </DbList>\\n</Data>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'AddImage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/xxxx.png',
+ 'isFileTransferUrl' => true,
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ExtraData',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '001',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '4DC6BB62-06D1-4242-939A-4AC500662E33',
+ 'type' => 'string',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'properties' => [
+ 'DataId' => [
+ 'description' => '',
+ 'example' => '1585903814940000',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4DC6BB62-06D1-4242-939A-4AC500662E33\\",\\n \\"Data\\": {\\n \\"DataId\\": \\"1585903814940000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4DC6BB62-06D1-4242-939A-4AC500662E33</RequestId>\\n<Data>\\n <DataId>1585903814940000</DataId>\\n</Data>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'ListImages' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Token',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '2',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Offset',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '1',
+ 'format' => 'int32',
+ 'required' => false,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'Limit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '50',
+ 'format' => 'int32',
+ 'required' => false,
+ 'type' => 'integer',
+ ],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'asc',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'EntityIdPrefix',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'U1',
+ 'required' => false,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '2B93C43A-F824-40C8-AF79-844342B0F43A',
+ 'type' => 'string',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'properties' => [
+ 'ImageList' => [
+ 'description' => '',
+ 'items' => [
+ 'properties' => [
+ 'EntityId' => [
+ 'description' => '',
+ 'example' => '5',
+ 'type' => 'string',
+ ],
+ 'CreatedAt' => [
+ 'description' => '',
+ 'example' => '1582838489213',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'UpdatedAt' => [
+ 'description' => '',
+ 'example' => '1582838489213',
+ 'format' => 'int64',
+ 'type' => 'integer',
+ ],
+ 'DataId' => [
+ 'description' => '',
+ 'example' => '001',
+ 'type' => 'string',
+ ],
+ 'ExtraData' => [
+ 'description' => '',
+ 'example' => '',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ 'type' => 'array',
+ ],
+ 'Token' => [
+ 'description' => '',
+ 'example' => '2',
+ 'type' => 'string',
+ ],
+ 'TotalCount' => [
+ 'description' => '',
+ 'example' => '100',
+ 'format' => 'int32',
+ 'type' => 'integer',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B93C43A-F824-40C8-AF79-844342B0F43A\\",\\n \\"Data\\": {\\n \\"ImageList\\": [\\n {\\n \\"EntityId\\": \\"5\\",\\n \\"CreatedAt\\": 1582838489213,\\n \\"UpdatedAt\\": 1582838489213,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"元素\\"\\n }\\n ],\\n \\"Token\\": \\"2\\",\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>2B93C43A-F824-40C8-AF79-844342B0F43A</RequestId>\\n<Data>\\n <Token>2</Token>\\n <TotalCount>100</TotalCount>\\n <ImageList>\\n <DataId>22</DataId>\\n <ExtraData>元素</ExtraData>\\n <EntityId>5</EntityId>\\n <UpdatedAt>1582838489213</UpdatedAt>\\n <CreatedAt>1582838489213</CreatedAt>\\n </ImageList>\\n</Data>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'SearchImage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ImageUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/imgsearch/SearchImage/SearchImage-ku8.png',
+ 'isFileTransferUrl' => true,
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Limit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '5',
+ 'format' => 'int32',
+ 'maximum' => '1000',
+ 'minimum' => '0',
+ 'required' => true,
+ 'type' => 'integer',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '1',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => 'A98DBCEB-45E2-5F5F-B5ED-F2340182FD87',
+ 'type' => 'string',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'properties' => [
+ 'MatchList' => [
+ 'description' => '',
+ 'items' => [
+ 'description' => '1',
+ 'properties' => [
+ 'ImageUrl' => [
+ 'description' => '',
+ 'example' => 'http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI4Fp1Gt5RzwdEXL3o****&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****',
+ 'type' => 'string',
+ ],
+ 'EntityId' => [
+ 'description' => '',
+ 'example' => '123456',
+ 'type' => 'string',
+ ],
+ 'Score' => [
+ 'description' => '',
+ 'example' => '10',
+ 'format' => 'float',
+ 'type' => 'number',
+ ],
+ 'DataId' => [
+ 'description' => '',
+ 'example' => '001',
+ 'type' => 'string',
+ ],
+ 'ExtraData' => [
+ 'description' => '',
+ 'example' => 'tangyan',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ 'type' => 'array',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A98DBCEB-45E2-5F5F-B5ED-F2340182FD87\\",\\n \\"Data\\": {\\n \\"MatchList\\": [\\n {\\n \\"ImageUrl\\": \\"http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&OSSAccessKeyId=LTAI****************&Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****\\",\\n \\"EntityId\\": \\"123456\\",\\n \\"Score\\": 10,\\n \\"DataId\\": \\"001\\",\\n \\"ExtraData\\": \\"tangyan\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchImageResponse>\\n <RequestId>A98DBCEB-45E2-5F5F-B5ED-F2340182FD87</RequestId>\\n <Data>\\n <MatchList>\\n <EntityId>123456</EntityId>\\n <Score>10</Score>\\n <DataId>1</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ie0c6-ipvnszc8584116.jpg?Expires=1635150265&amp;OSSAccessKeyId=LTAI****************&amp;Signature=8rj0%2Bxg%2Bni5NxQAcEQqISX5j1w****</ImageUrl>\\n <ExtraData>zhaoliu</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123457</EntityId>\\n <Score>1.1762875356333269</Score>\\n <DataId>2</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1uimages1.jpg?Expires=1635151060&amp;OSSAccessKeyId=LTAI****************&amp;Signature=%2Byceg79YwiShi1RWDSQ%2FSZcIec****</ImageUrl>\\n <ExtraData>wangwu</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123458</EntityId>\\n <Score>0.9932686334385976</Score>\\n <DataId>3</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1ximages2.jpg?Expires=1635151141&amp;OSSAccessKeyId=LTAI****************&amp;Signature=rHoEnFco%2BfLWyzHZGFwUpOaySZ****</ImageUrl>\\n <ExtraData>zhangsan</ExtraData>\\n </MatchList>\\n <MatchList>\\n <EntityId>123459</EntityId>\\n <Score>1.2938829068163327</Score>\\n <DataId>4</DataId>\\n <ImageUrl>http://vision-console.oss-cn-shanghai.aliyuncs.com/1902352443710590/kv6dvd1m641.jpg?Expires=1635150931&amp;OSSAccessKeyId=LTAI****************&amp;Signature=5m8NJ50eokih%2Fcxp%2B%2BnsA%2BTT%2BG****</ImageUrl>\\n <ExtraData>lisi</ExtraData>\\n </MatchList>\\n </Data>\\n</SearchImageResponse>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'DeleteImageDb' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'DeleteImage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DbName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'default',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '1',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '3F3F81A5-4C37-4716-AE5C-518D2537365C',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3F3F81A5-4C37-4716-AE5C-518D2537365C\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3F3F81A5-4C37-4716-AE5C-518D2537365C</RequestId>","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'imgsearch.cn-shanghai.aliyuncs.com',
+ ],
+ ],
+];