集成SDK

1. 登录SDK中心，选择将要使用产品，例如您将要调用短信服务 SMS（Short Message Service）的API。

2. 在安装页面，SDK 代系选择V2.0，所有语言选择PHP。然后在快速入门页签中，您可以获取短信服务 SMS（Short Message Service）的SDK安装方式。

   

4. 异常处理

V2.0 PHP SDK将异常进行了细致的分类，主要划分为InvalidArgumentException、TeaUnretryableException和TeaException。

• TeaUnretryableException：主要是因为网络问题造成，一般是网络问题达到最大重试次数后抛出。

• InvalidArgumentException：主要是由于未填写必填参数或填写的参数类型不匹配所导致，可以通过查看异常信息中的message来定位错误。

• TeaException：主要以业务报错为主的异常。

更多关于异常处理的介绍，请参见异常处理。

特殊场景：文件上传 Advance 接口配置

在使用图像搜索、视觉智能开放平台等云产品处理本地图片或上传图片时，官方文档中提供的OpenAPI接口不支持直接上传文件。若需上传文件，可以使用云产品提供的Advance接口，该接口支持传递文件流对象。其底层实现机制为：云产品会将上传的文件临时存储于阿里云OSS上，默认存储地域为cn-shanghai，并通过读取该OSS中的临时文件来实现相关功能。以阿里云提供的视觉智能开放平台-人脸人体的DetectBodyCount接口为例：

1. 初始化请求客户端

   请注意需同时设置regionId和云产品的endpoint。其中，regionId表示临时文件在OSS中所存储的地域。如果未设置regionId，可能会由于云产品与OSS所在地域不同，导致在调用OpenAPI时出现超时等问题。

   function createClient()
   {
       $config = new Config([
           // getenv表示从环境变量获取凭据
           // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
           "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
           // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
           "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
       ]);
       // endpoint 和 regionId 需设置为同一地域
       $config->endpoint = "facebody.cn-shanghai.aliyuncs.com";
       $config->regionId = "cn-shanghai";
       return new Facebody($config);
   }

2. 创建请求对象

   通过创建<OpenAPI名称>AdvanceRequest请求对象传递文件流。参数名固定为ImageURLObject。

           // 读取文件并转为 Stream 对象
           $imagePath = "<FILE_PATH>";   // 需替换文件路径
           try {
               $fileStream = new Stream(fopen($imagePath, "r"));
           } catch (\Exception $e) {
               die("文件读取失败: " . $e->getMessage());
           }
           // 创建请求对象设置参数
           $detectBodyCountAdvanceRequest = new DetectBodyCountAdvanceRequest([
               "imageURLObject" =>  $fileStream
           ]);   

3. 发起请求

   需调用函数<接口名称>Advance发起请求。

    // 运行时配置
    $runtime = new RuntimeOptions([]);
    $client = self::createClient();
    // 发起请求      
    $client->detectBodyCountAdvance($detectBodyCountAdvanceRequest, $runtime);

<?php

// composer require alibabacloud/facebody-20191230

namespace AlibabaCloud\SDK\Sample;
use Darabonba\OpenApi\Models\Config;
use GuzzleHttp\Psr7\Stream;
use AlibabaCloud\SDK\Facebody\V20191230\Facebody;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\SDK\Facebody\V20191230\Models\DetectBodyCountAdvanceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

require_once 'vendor/autoload.php';

class Sample
{
    public static function createClient()
    {
        $config = new Config([
            // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        ]);
        $config->regionId = "cn-shanghai";
        return new Facebody($config);
    }

    public static function main()
    {
        $client = self::createClient();

        // 读取文件并转为 Stream 对象  
        $imagePath = "<FILE_PATH>";   // 需替换文件路径
        if (!file_exists($imagePath)) {
            die("File does not exist: $imagePath");
        }
        try {
            $fileStream = new Stream(fopen($imagePath, "r"));
        } catch (Exception $e) {
            die("文件读取失败： " . $e->getMessage());
        }
        // 创建请求对象
        $detectBodyCountAdvanceRequest = new DetectBodyCountAdvanceRequest([
            "imageURLObject" => $fileStream
        ]);
        // 运行时配置
        $runtime = new RuntimeOptions([]);
        try {
            // 发起请求
            $resp = $client->detectBodyCountAdvance($detectBodyCountAdvanceRequest, $runtime);
            var_dump($resp->body);
        } catch (Exception $error) {
            if (!($error instanceof TeaError)) {
                $error = new TeaError([], $error->getMessage(), $error->getCode(), $error);
            }
            var_dump($error);
        }
    }
}

Sample::main();

常见问题

• 调用OpenAPI时报错，提示“You are not authorized to perform this operation”。

  问题原因：您所使用的AccessKey对应的RAM用户没有权限调用该API。

  解决方法：请为该RAM用户授予相应OpenAPI权限。关于如何为RAM用户进行授权，请参见为RAM用户授权。

  例如，当您在调用SendSms时提示“You are not authorized to perform this operation”，您可以创建如下所示的自定义权限策略，并为该RAM用户授予相应的权限。

  {
    "Version": "1",
    "Statement": [
      {
        "Effect": "Allow",
        "Action": "dysms:SendSms",
        "Resource": "*"
      }
    ]
  }

• 在调用OpenAPI时发生错误，提示为 PHP Fatal error: Uncaught exception 'GuzzleHttp\Exception\RequestException'，错误信息为 'cURL error 3'，该错误与 'Endpoint' 相关。

  问题原因：您所调用的OpenAPI不支持在初始化请求客户端时填写的Endpoint。

  解决方法：请查看Endpoint 配置，修改Endpoint后重新调用OpenAPI。

• 调用OpenAPI时报错，提示：“PHP Fatal error: Uncaught ArgumentCountError: Too few arguments to function AlibabaCloud\Credentials\AccessKeyCredential::__construct(), 1 passed and exactly 2” 该错误与'AccessKey'相关。

  问题原因：您的AccessKey未正确传递。

  解决方法：在初始化请求客户端时，检查是否正确传递AccessKey。请注意getenv("XXX")表示从环境变量中获取XXX的值。

• 使用SDK时报错，code ：414 URL Too Long。

  问题原因：该问题与所设置的请求方式无关。在使用SDK时，请求参数是通过URL进行传递的。当参数数量过多或参数值过长时，可能会导致URL长度超出限制，从而引发请求失败。

  解决方法：为避免因使用SDK时URL过长而引发的问题，建议您改用V3版本请求体&签名机制，使用自签名的方式通过请求体body传参，body类型需设置为Content-Type: application/x-www-form-urlencoded。

更多SDK使用过程中的报错问题解决方案，请参见常见问题。