Alibaba Cloud SDK:Integrate with Alibaba Cloud SDK V2.0 for PHP

1. Log on to SDK Center and select the service whose SDK you want to use. In this example, Short Message Service (SMS) is selected.

2. On the Install page, select V2.0 from the SDK Generation drop-down list and click PHP in the All languages section. On the Quick Start tab, obtain the installation method of the Short Message Service (SMS) SDK.

   

4. Handle errors

Alibaba Cloud SDK V2.0 for PHP classifies exceptions into the following types:

• TeaUnretryableException: In most cases, this type of exception is caused by network issues and is reported when the maximum number of retries is reached.

• InvalidArgumentException: In most cases, this type of error is trigger when a required parameter is not specified or the parameter type is invalid. You can check the error message to locate the error.

• TeaException: In most cases, this type of exception is caused by business errors.

For more information about how to handle SDK exceptions, see Exception handling.

Special scenario: File upload through the Advance operation

When you use Image Search or Visual Intelligence API (VIAPI) to process images on an on-premises machine or upload images, the API of the Image Search or VIAPI described in the documentation does not support direct upload. To upload images, you need to use the Advance operation, which supports transmission of file streams. The cloud service temporarily stores the uploaded file in Object Storage Service (OSS), and reads the temporary file from OSS when necessary. The default region of OSS is cn-shanghai. The following example shows how to call the DetectBodyCount operation of VIAPI:

1. Initialize a request client

   Make sure that both the regionId parameter and the endpoint of the cloud service are specified. regionId indicates the OSS region in which the temporary files are stored. If you do not configure the regionId parameter, the cloud service may use a different region than OSS, resulting in API timeouts.

   function createClient()
   {
       $config = new Config([
           // getenv specifies that the access credential is obtained from environment variables.
           // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
           "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
           // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
           "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
       ]);
       // Specify the same region for the endpoint and regionId parameters.
       $config->endpoint = "facebody.cn-shanghai.aliyuncs.com";
       $config->regionId = "cn-shanghai";
       return new Facebody($config);
   }

2. Create a request object

   Create the <API operation>AdvanceRequest request object to pass file streams. In the request object, set the parameter name to ImageURLObject.

   // Read the file and convert it to a Stream object.
           $imagePath = "<FILE_PATH>";   // Replace <FILE_PATH> with the actual file path.
           try {
               $fileStream = new Stream(fopen($imagePath, "r"));
           } catch (\Exception $e) {
               die("Failed to read the file: " . $e->getMessage());
           }
           // Create a request object and configure the request parameters.
           $detectBodyCountAdvanceRequest = new DetectBodyCountAdvanceRequest([
               "imageURLObject" =>  $fileStream
           ]);   

3. Initiate a request

   Call the <API operation>AdvanceRequest operation.

   // Configure the runtime parameters.
    $runtime = new RuntimeOptions([]);
    $client = self::createClient();
    // Send the request.      
    $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([
            // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // Required. Make sure that the following environment variable is set in the code runtime environment: 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();

        // Read the file and convert it to a Stream object.  
        $imagePath = "<FILE_PATH>";   // Replace the value with the actual file path.
        if (!file_exists($imagePath)) {
            die("File does not exist: $imagePath");
        }
        try {
            $fileStream = new Stream(fopen($imagePath, "r"));
        } catch (Exception $e) {
            die("Failed to read the file: " . $e->getMessage());
        }
        // Create a request object.
        $detectBodyCountAdvanceRequest = new DetectBodyCountAdvanceRequest([
            "imageURLObject" => $fileStream
        ]);
        // Configure runtime settings.
        $runtime = new RuntimeOptions([]);
        try {
            // Send the request.
            $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();

FAQ

• How do I handle the "You are not authorized to perform this operation" error thrown by an API operation?

  Possible causes: The AccessKey pair of the Resource Access Management (RAM) user does not have the permissions to call the API operation.

  Solutions: Grant the required permissions to the RAM user. For more information, see Grant permissions to a RAM user.

  For example, if the "You are not authorized to perform this operation" error is thrown by the SendMessageToGlobe API operation, create the following custom policy to grant the required permissions to the RAM user:

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

• How do I handle the "PHP Fatal error: Uncaught exception 'GuzzleHttp\Exception\RequestException" endpoint error whose error message is cURL error 3?

  Possible causes: The API operation does not support the endpoint that you specify when you initialize the request client.

  Solutions: Specify a supported endpoint and try again. For more information, see Configure an endpoint.

• How do I handle the "PHP Fatal error: Uncaught ArgumentCountError: Too few arguments to function AlibabaCloud\Credentials\AccessKeyCredential::__construct(), 1 passed and exactly 2" AccessKey error thrown by an API operation?

  Possible causes: The AccessKey pair is not correctly passed to the request.

  Solutions: Make sure that the AccessKey pair is correctly passed when you initialize the request client. The XXX value of getenv("XXX") is obtained form the environment variable.

• How do I handle the "code: 414 URL Too Long" error thrown by Alibaba Cloud SDK?

  Possible causes: This issue is not caused by the request method. When you use Alibaba Cloud SDK, request parameters are passed in URLs. If a URL contains an excessive number of parameters or overlength parameter values, the URL may exceed the maximum length and cause request failures.

  Solutions: To prevent overlength URLs, we recommend that you use request syntax and signature method V3. Use self-signed signatures to pass parameters in the request body and set the body type to Content-Type: application/x-www-form-urlencoded.

For more information about how to handle SDK errors, see FAQ about SDK for PHP.