本文介紹圖像搜索服務PHP SDK的使用方法及示例。
說明
如需了解更多產品詳情和獲取技術支持,請單擊在線咨詢或通過釘釘群(35035130)聯系我們。
接口列表
接口名稱 | 接口說明 |
Add | 增加圖片。 |
SearchImageByPic | 使用圖片進行搜索。 |
SearchImageByName | 指定名稱,使用已入庫的圖片進行搜索。 |
Delete | 刪除圖片。 |
UpdateImage | 修改圖片。 |
Detail | 查詢實例信息。 |
DumpMeta | 元信息導出任務。 |
DumpMetaList | 元信息導出任務列表。 |
BatchTask | 批量任務。 |
BatchTaskList | 批量任務列表。 |
準備工作
在安裝和使用阿里云SDK前,確保您已經注冊阿里云賬號并生成訪問密鑰(AccessKey)。詳情請參見創建AccessKey。
說明
PHP: >=5.5
composer鏡像
https://developer.aliyun.com/composer
安裝依賴
使用Composer,獲取SDK。
composer require alibabacloud/imagesearch-20201214
使用composer.json文件示例。
{ "require": { "alibabacloud/imagesearch-20201214": "^4.0" } }
依賴相關代碼示例如下。
declare (strict_types=1);
require __DIR__ . '/vendor/autoload.php';
use AlibabaCloud\SDK\ImageSearch\V20201214\ImageSearch;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\AddImageAdvanceRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\SearchImageByPicAdvanceRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\SearchImageByNameRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\DeleteImageRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\UpdateImageRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\DetailRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\DumpMetaRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\DumpMetaListRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\IncreaseInstanceRequest;
use AlibabaCloud\SDK\ImageSearch\V20201214\Models\IncreaseListRequest;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use GuzzleHttp\Psr7\Stream;
Add接口
代碼示例
function _addImage() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new AddImageAdvanceRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 必填,商品id,最多支持 512個字符。 // 一個商品可有多張圖片。 $request->productId = "testPhp"; // 必填,圖片名稱,最多支持 512個字符。 // 1. ProductId + PicName唯一確定一張圖片。 // 2. 如果多次添加圖片具有相同的ProductId + PicName,以最后一次添加為準,前面添加的圖片將被覆蓋。 $request->picName = "testPhp"; // 選填,圖片類目。 // 1. 對于商品搜索:若設置類目,則以設置的為準;若不設置類目,將由系統進行類目預測,預測的類目結果可在Response中獲取 。 // 2. 對于布料、商標、通用搜索:不論是否設置類目,系統會將類目設置為88888888。 $request->categoryId = 3; // 選填,用戶自定義的內容,最多支持4096個字符。 // 查詢時會返回該字段。例如可添加圖片的描述等文本。 $request->customContent = "this is a simple test"; // 選填,整數類型屬性,可用于查詢時過濾,查詢時會返回該字段。 // 例如不同的站點的圖片/不同用戶的圖片,可以設置不同的IntAttr,查詢時通過過濾來達到隔離的目的 $request->intAttr = 56; // 選填,字符串類型屬性,最多支持 128個字符。可用于查詢時過濾,查詢時會返回該字段。 $request->strAttr = "test"; // 選填,是否需要進行主體識別,默認為true。 // 1.為true時,由系統進行主體識別,以識別的主體進行搜索,主體識別結果可在Response中獲取。 // 2. 為false時,則不進行主體識別,以整張圖進行搜索。 // 3.對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->crop = true; // 選填,圖片的主體區域,格式為 x1,x2,y1,y2, 其中 x1,y1 是左上角的點,x2,y2是右下角的點。設置的region 區域不要超過圖片的邊界。 // 若用戶設置了Region,則不論Crop參數為何值,都將以用戶輸入Region進行搜索。 // 對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->region = "167,467,221,407"; // 圖片內容,最多支持 4MB大小圖片以及5s的傳輸等待時間。當前僅支持PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM格式圖片; // 對于商品、商標、通用圖片搜索,圖片長和寬的像素必須都大于等于100且小于等于4096; // 對于布料搜索,圖片長和寬的像素必須都大于等于448且小于等于4096; // 圖像中不能帶有旋轉信息 // 使用URL方式釋放下方注釋即可。 // composer require alibabacloud/darabonba-stream // use AlibabaCloud\Darabonba\Stream\StreamUtil; // $imageStream = StreamUtil::readFromFilePath("<fileUrl>"); // 使用圖片file新增圖片 $imageStream = new Stream(fopen("<filePath>", 'r+')); $request->picContentObject = $imageStream; $runtime = new RuntimeOptions(); $runtime->maxIdleConns = 3; $runtime->connectTimeout = 3000; $runtime->readTimeout = 3000; try { $response = $client->addImageAdvance($request, $runtime); var_dump($response->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } }
結果示例
{ ["requestId"]=> string(36) "242CB8B7-DD36-42ED-9A76-37915DC7ED81" ["success"]=> bool(true) ["message"]=> string(7) "success" ["code"]=> int(0) ["picInfo"]=> array(2) { ["CategoryId"]=> int(0) ["Region"]=> string(15) "167,477,221,407" } ["_name":protected]=> array(5) { ["requestId"]=> string(9) "RequestId" ["success"]=> string(7) "Success" ["message"]=> string(7) "Message" ["code"]=> string(4) "Code" ["picInfo"]=> string(7) "PicInfo" } ["_required":protected]=> array(0) { } }
SearchImageByPic接口
代碼示例
function _getImageByPic() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new SearchImageByPicAdvanceRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxx"; // 圖片內容,最多支持 4MB大小圖片以及5s的傳輸等待時間。當前僅支持PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM格式圖片; // 對于商品、商標、通用圖片搜索,圖片長和寬的像素必須都大于等于100且小于等于4096; // 對于布料搜索,圖片長和寬的像素必須都大于等于448且小于等于4096; // 圖像中不能帶有旋轉信息 // 使用URL方式釋放下方注釋即可。 // composer require alibabacloud/darabonba-stream // use AlibabaCloud\Darabonba\Stream\StreamUtil; // $imageStream = StreamUtil::readFromFilePath("<fileUrl>"); // 通過圖片file查詢相似圖片 $imageStream = new Stream(fopen("<filePath>", 'r+')); $request->picContentObject = $imageStream; // 選填,圖片類目。 // 1. 對于商品搜索:若設置類目,則以設置的為準;若不設置類目,將由系統進行類目預測,預測的類目結果可在Response中獲取。 // 2. 對于布料、商標、通用搜索:不論是否設置類目,系統會將類目設置為88888888。 $request->categoryId = 3; // 1.為true時,由系統進行主體識別,以識別的主體進行搜索,主體識別結果可在Response中獲取。 // 2. 為false時,則不進行主體識別,以整張圖進行搜索。 // 3.對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->crop = true; // 選填,圖片的主體區域,格式為 x1,x2,y1,y2, 其中 x1,y1 是左上角的點,x2,y2是右下角的點。設置的region 區域不要超過圖片的邊界。 // 若用戶設置了Region,則不論Crop參數為何值,都將以用戶輸入Region進行搜索。 // 對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->region = "167,467,221,407"; // 選填,過濾條件// int_attr支持的操作符有>、>=、<、<=、=,str_attr支持的操作符有=和!=,多個條件之支持AND和OR進行連接。 // 示例: // 1. 根據IntAttr過濾結果,int_attr>=100 // 2. 根據StrAttr過濾結果,str_attr!="value1" // 3. 根據IntAttr和StrAttr聯合過濾結果,int_attr=1000 AND str_attr="value1" $request->filter = "int_attr=56 AND str_attr =\"test\""; $runtime = new RuntimeOptions(); $runtime->maxIdleConns = 3; $runtime->connectTimeout = 3000; $runtime->readTimeout = 3000; try { $response = $client->searchImageByPicAdvance($request, $runtime); var_dump($response->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
{ ["requestId"]=> string(36) "453517A3-7D00-476E-A946-8CC3B9DC6FA1" ["success"]=> bool(true) ["code"]=> int(0) ["msg"]=> string(7) "success" ["auctions"]=> array(5) { [0]=> array(4) { ["CategoryId"]=> int(0) ["PicName"]=> string(7) "vae.jpg" ["ProductId"]=> string(4) "1000" ["SortExprValues"]=> string(22) "7.33136443711219e+24;0" ["Score"]=> float(1) } [1]=> array(4) { ["CategoryId"]=> int(0) ["PicName"]=> string(4) "test" ["ProductId"]=> string(4) "test" ["SortExprValues"]=> string(22) "7.33136443711219e+24;0" ["Score"]=> float(1) } ........ [4]=> array(4) { ["CategoryId"]=> int(0) ["PicName"]=> string(4) "test" ["ProductId"]=> string(4) "1000" ["SortExprValues"]=> string(22) "7.33136443711219e+24;0" ["Score"]=> float(1) } } ["head"]=> array(3) { ["DocsFound"]=> int(5) ["DocsReturn"]=> int(5) ["SearchTime"]=> int(171) } ["picInfo"]=> array(3) { ["CategoryId"]=> int(0) ["MultiRegion"]=> array(1) { [0]=> array(1) { ["Region"]=> string(15) "134,705,187,785" } } ["AllCategories"]=> array(14) { [0]=> array(2) { ["Id"]=> int(0) ["Name"]=> string(4) "Tops" } ........ [13]=> array(2) { ["Id"]=> int(88888888) ["Name"]=> string(5) "Other" } } ["Region"]=> string(15) "167,477,221,407" } ["_name":protected]=> array(7) { ["requestId"]=> string(9) "RequestId" ["success"]=> string(7) "Success" ["code"]=> string(4) "Code" ["msg"]=> string(3) "Msg" ["auctions"]=> string(8) "Auctions" ["head"]=> string(4) "Head" ["picInfo"]=> string(7) "PicInfo" } ["_required":protected]=> array(0) { } }
SearchImageByName接口
代碼示例
function _getImageByName() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new SearchImageByNameRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxxx"; // 必填,商品id,最多支持 512個字符。 // 一個商品可有多張圖片。 $request->productId = "testPhp"; // 必填,圖片名稱,最多支持 512個字符。 // 1. ProductId + PicName唯一確定一張圖片。 // 2. 如果多次添加圖片具有相同的ProductId + PicName,以最后一次添加為準,前面添加的圖片將被覆蓋。 $request->picName = "testPhp"; // 選填,圖片類目。 // 1. 對于商品搜索:若設置類目,則以設置的為準;若不設置類目,將由系統進行類目預測,預測的類目結果可在Response中獲取。 // 2. 對于布料、商標、通用搜索:不論是否設置類目,系統會將類目設置為88888888。 $request->categoryId = 3; // 1.為true時,由系統進行主體識別,以識別的主體進行搜索,主體識別結果可在Response中獲取。 // 2. 為false時,則不進行主體識別,以整張圖進行搜索。 // 3.對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->crop = true; // 選填,圖片的主體區域,格式為 x1,x2,y1,y2, 其中 x1,y1 是左上角的點,x2,y2是右下角的點。設置的region 區域不要超過圖片的邊界。 // 若用戶設置了Region,則不論Crop參數為何值,都將以用戶輸入Region進行搜索。 // 對于布料圖片搜索,此參數會被忽略,系統會以整張圖進行搜索。 $request->region = "167,467,221,407"; // 選填,過濾條件// int_attr支持的操作符有>、>=、<、<=、=,str_attr支持的操作符有=和!=,多個條件之支持AND和OR進行連接。 // 示例: // 1. 根據IntAttr過濾結果,int_attr>=100 // 2. 根據StrAttr過濾結果,str_attr!="value1" // 3. 根據IntAttr和StrAttr聯合過濾結果,int_attr=1000 AND str_attr="value1" $request->filter = "int_attr=56 AND str_attr =\"test\""; try { $response = $client->SearchImageByName($request); var_dump($response->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
["requestId"]=> string(36) "9248A5FC-97AB-4A96-8764-C771CF61D9A1" ["success"]=> bool(true) ["code"]=> int(0) ["msg"]=> string(7) "success" ["auctions"]=> array(5) { [0]=> array(4) { ["CategoryId"]=> int(0) ["PicName"]=> string(7) "vae.jpg" ["ProductId"]=> string(4) "1000" ["SortExprValues"]=> string(22) "7.33136443711219e+24;0" ["Score"]=> float(1) } ........ [4]=> array(4) { ["CategoryId"]=> int(0) ["PicName"]=> string(4) "test" ["ProductId"]=> string(4) "1000" ["SortExprValues"]=> string(22) "7.33136443711219e+24;0" ["Score"]=> float(1) } } ["head"]=> array(3) { ["DocsFound"]=> int(5) ["DocsReturn"]=> int(5) ["SearchTime"]=> int(21) } ["picInfo"]=> array(2) { ["CategoryId"]=> int(0) ["MultiRegion"]=> array(1) { [0]=> array(1) { ["Region"]=> string(15) "134,705,187,785" } } ["AllCategories"]=> array(14) { [0]=> array(2) { ["Id"]=> int(0) ["Name"]=> string(4) "Tops" } ........ [13]=> array(2) { ["Id"]=> int(88888888) ["Name"]=> string(5) "Other" } } } ["_name":protected]=> array(7) { ["requestId"]=> string(9) "RequestId" ["success"]=> string(7) "Success" ["code"]=> string(4) "Code" ["msg"]=> string(3) "Msg" ["auctions"]=> string(8) "Auctions" ["head"]=> string(4) "Head" ["picInfo"]=> string(7) "PicInfo" } ["_required":protected]=> array(0) { } }
Delete接口
代碼示例
function _deleteImage() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new DeleteImageRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 必填,圖片名稱,最多支持 512個字符。 // 1. ProductId + PicName唯一確定一張圖片。 $request->productId = "test"; // 2. 選填,圖片名稱。若不指定本參數,則刪除ProductId下所有圖片;若指定本參數,則刪除ProductId+PicName指定的圖片。 $request->picName = "test"; try { $response = $client->deleteImage($request); var_dump($response->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
{ ["requestId"]=> string(36) "052ECD87-933D-4E65-94F7-F0C0947E41A1" ["success"]=> bool(true) ["message"]=> string(7) "success" ["code"]=> int(0) ["_name":protected]=> array(4) { ["requestId"]=> string(9) "RequestId" ["success"]=> string(7) "Success" ["message"]=> string(7) "Message" ["code"]=> string(4) "Code" } ["_required":protected]=> array(0) { } }
UpdateImage接口
代碼示例
function _updateImage() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new UpdateImageRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 必填,商品ID 不可修改。 $request->productId = "1"; // 必填,圖片名稱,不可修改。 $request->picName = "1"; // 選填,整數類型屬性,可用于查詢時過濾,查詢時會返回該字段。 $request->intAttr = 10; // 選填,字符串類型屬性,最多支持 128個字符。可用于查詢時過濾,查詢時會返回該字段。 $request->strAttr = "test"; // 選填,用戶自定義的內容,最多支持4096個字符。 $request->customContent = "這是一個測試說明"; try { $response = $client->updateImage($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(3) { ["Code"]=> int(0) ["RequestId"]=> string(36) "2CD69717-846D-167A-89AD-647213332248" ["Success"]=> bool(true) }
Detail接口
代碼示例
function _detail() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new DetailRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; try { $response = $client->detail($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(3) { ["Instance"]=> array(8) { ["Capacity"]=> int(10) ["Name"]=> string(19) "xxxxxxx" ["Qps"]=> int(1) ["Region"]=> string(11) "cn-shanghai" ["ServiceType"]=> int(0) ["TotalCount"]=> int(99999) ["UtcCreate"]=> int(1620382716000) ["UtcExpireTime"]=> int(1623081600000) } ["RequestId"]=> string(36) "41465B01-11B4-149D-BB6F-BB498B3C39F0" ["Success"]=> bool(true) }
DumpMeta接口
代碼示例
function _dumpMeta() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new DumpMetaRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; try { $response = $client->dumpMeta($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(3) { ["Data"]=> array(2) { ["DumpMetaStatus"]=> string(10) "PROCESSING" ["Id"]=> int(572) } ["RequestId"]=> string(36) "A1234E2C-C99E-122C-97D1-F30FE012533B" ["Success"]=> bool(true) }
DumpMetaList接口
代碼示例
function _dumpMetaList() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new DumpMetaListRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 選填,元數據導出任務id。 $request->id = 567; // 選填,返回結果起始位置,默認1。 $request->pageNumber = 1; // 選填,返回結果數量,默認20。 $request->pageSize = 1; try { $response = $client->dumpMetaList($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(2) { ["Data"]=> array(4) { ["DumpMetaList"]=> array(1) { [0]=> array(7) { ["Code"]=> string(1) "0" ["Id"]=> int(567) ["MetaUrl"]=> string(208) "https://xx/xx" ["Msg"]=> string(7) "success" ["Status"]=> string(7) "SUCCESS" ["UtcCreate"]=> int(1639969113000) ["UtcModified"]=> int(1639969140000) } } ["PageNumber"]=> int(1) ["PageSize"]=> int(1) ["TotalCount"]=> int(1) } ["RequestId"]=> string(36) "46044936-BA2E-10E2-9C82-C00FF83862E5" }
BatchTask接口
代碼示例
function _batchTask() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new IncreaseInstanceRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 必填 oss 中 bucket名稱。 $request->bucketName = "xxxx"; // 必填,路徑,必須 / 開頭, 非 / 結尾。 // 此路徑下需要提前準備好 increment.meta 文件,可參考,用戶指南下的批量操作文檔。 $request->path = "/public/xxx"; // 選填,請求成功回調地址,http(s)://。 $request->callbackAddress = "http://xxx/xxx"; try { $response = $client->increaseInstance($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(3) { ["Data"]=> array(2) { ["Id"]=> int(1475) ["IncrementStatus"]=> string(10) "PROCESSING" } ["RequestId"]=> string(36) "768C6C02-E3FE-1024-8461-103F7C529EFA" ["Success"]=> bool(true) }
BatchTaskList接口
代碼示例
function _batchTaskList() { $config = new Config(); // 創建AK/SK參考:http://bestwisewords.com/document_detail/116401.htm //阿里云賬號AccessKey擁有所有API的訪問權限,建議您使用RAM用戶進行API訪問或日常運維。 //強烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導致AccessKey泄露,威脅您賬號下所有資源的安全。 //本示例以將AccessKey ID和AccessKey Secret保存在環境變量為例說明。您也可以根據業務需要,保存到配置文件里。 $config->accessKeyId = getenv("CC_AK_ENV"); $config->accessKeySecret = getenv("CC_SK_ENV"); // 請您更換成您購買實例的區域,例如您購買的實例區域為杭州,則更換為regionId="cn-hangzhou" $config->regionId = "<regionId>"; // 請更換成您購買實例的區域,例如購買的是杭州區域,則endpoint="imagesearch.cn-hangzhou.aliyuncs.com" $config->endpoint = "imagesearch.[regionId].aliyuncs.com"; // 以下為內網(VPC)訪問方式 // 說明:內網(VPC)訪問:僅限同區域ECS或資源的訪問,例如您購買的圖像搜索實例是華東2(上海),那么您的ECS或資源也必須在華東2(上海)才能通過內網VPC地址訪問圖搜服務,否則會調用不通,如果遇到調用不通,請先檢查您的ECS或資源與圖像搜索是否在同一個區域。 // $config->endpointType = "internal"; // 如果是內網訪問圖像搜索服務,則endpointType為必填項,值統一為"internal" // $config->endpoint = "imagesearch-vpc.[regionId].aliyuncs.com"; // 為內網訪問(VPC)地址,請您更換為您購買實例的區域,例如您購買實例的區域為杭州,則endpoint="imagesearch-vpc.cn-hangzhou.aliyuncs.com" $client = new ImageSearch($config); $request = new IncreaseListRequest(); // 必填,圖像搜索實例名稱。注意是實例名稱不是實例ID。購買后通過上云層管控臺實例信息一欄查看:https://imagesearch.console.aliyun.com/overview $request->instanceName = "xxxxxx"; // 選填,任務id。 $request->id = 567; // 選填,查詢oss 的 BucketName。 $request->bucketName = "xxxx"; // 選填,查詢oss 的 path 路徑。 $request->path = "/public/xxx"; // 選填,返回結果起始位置,默認1。 $request->pageNumber = 1; // 選填,返回結果數量,默認20。 $request->pageSize = 1; try { $response = $client->increaseList($request); var_dump($response->body->toMap()); } catch (TeaUnableRetryError $e) { var_dump($e->getLastException(), $e->getLastRequest()); } catch (Exception $e) { } }
結果示例
array(2) { ["Data"]=> array(4) { ["Increments"]=> array(1) { ["Instance"]=> array(1) { [0]=> array(9) { ["BucketName"]=> string(21) "xxxxx" ["Code"]=> string(1) "0" ["ErrorUrl"]=> string(226) "https://xx/xx" ["Id"]=> int(1464) ["Msg"]=> string(7) "success" ["Path"]=> string(23) "/public/xxx" ["Status"]=> string(6) "NORMAL" ["UtcCreate"]=> int(1639107872000) ["UtcModified"]=> int(1639125540000) } } } ["PageNumber"]=> int(1) ["PageSize"]=> int(1) ["TotalCount"]=> int(1) } ["RequestId"]=> string(36) "603C696F-EC04-101F-8767-29A63382237A" }
文檔內容是否對您有幫助?