Alibaba Cloud SDK:Use Alibaba Cloud SDKs for PHP in an IDE

Go to OpenAPI Explorer. Search for the API operation that you want to call. In this example, the DescribeRegions operation of Elastic Compute Service (ECS) is used. Enter DescribeRegions in the search box and click the operation name in the search results to go to the API debugging page.

On the Parameters tab, specify the parameters based on your requirements. When you specify the parameters, read the information on the Document tab on the right side of the debugging page. Make sure that you understand the usage notes of the operation and the description of each parameter. Pay attention to billing-related information.

On the SDK Sample Code tab on the right side of the debugging page, select the PHP programming language and click Download Project to download the complete sample project package to your computer. Then, decompress the package.

Open the decompressed package in VS Code and run the composer install command in the terminal to install the dependencies that are required by the sample project.

The following error may be reported when you run the composer install command:

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires alibabacloud/ecs-20140526 ^4.1.6 -> satisfiable by alibabacloud/ecs-20140526[4.1.6].
    - alibabacloud/ecs-20140526 4.1.6 requires alibabacloud/tea-utils ^0.2.20 -> found alibabacloud/tea-utils[dev-master, 0.1.0, ..., 0.2.19] but it does not match the constraint.

To fix the error, you can modify the version of the alibabacloud/ecs-20140526 dependency in the composer.json file.

"alibabacloud/ecs-20140526": "^4.1",

Run the php src/Sample.php command in the terminal to run the sample code. If "statusCode":200 is returned in the response, the call is successful.

Go to SDK Center and select the cloud service whose SDK you want to use. In this example, ECS is used. Select V2.0 from the SDK Generation drop-down list and select PHP in the All languages section.

Open VS Code. In the top navigation bar, choose File > Open Folder. Create and select a project folder or select an existing project folder. In this example, a folder named phpprojects is created and selected.

Copy the command that is used to install the SDK and run the command in the terminal to install the SDK.

In the EXPLORER panel, right-click the blank area and select New File to create a PHP file. Name the file demo.php.

Initialize a client. To call Alibaba Cloud API operations, you must initialize a client first. In this example, an ECS client is initialized.

<?php
use AlibabaCloud\Credentials\Credential\Config;
use AlibabaCloud\SDK\Ecs\V20140526\Ecs;


class Sample
{
    /**
     * Create an ECS client.
     * You can use this method to initialize and return an ECS client, which can be used to call API operations of ECS. 
     * You can obtain the AccessKey ID and AccessKey secret from environment variables to configure the ECS client. This prevents leakage of sensitive information and ensures secure access to the sensitive information. 
     * 
     * @return Ecs Return a configured ECS client.
     */
    public static function createClient()
    {
        // Create a configuration object.
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), // Obtain the AccessKey ID of a Resource Access Management (RAM) user from an environment variable.
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"), // Obtain the AccessKey secret of the RAM user from an environment variable.
            "endpoint" => "ecs.cn-hangzhou.aliyuncs.com" // Specify the ECS endpoint.
        ]);

        // Create another ECS client based on the preceding configurations.
        return new Ecs($config);
    }
}

Call the API operation. Before you call an API operation, you must read the corresponding API documentation. In this example, the DescribeRegions operation of ECS is used.

<?php

require_once 'vendor/autoload.php';

use AlibabaCloud\SDK\Ecs\V20140526\Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;


class Sample
{
    /**
     * Create an ECS client.
     * You can use this method to initialize and return an ECS client, which can be used to call API operations of ECS. 
     * You can obtain the AccessKey ID and AccessKey secret from environment variables to configure the ECS client. This prevents leakage of sensitive information and ensures secure access to the sensitive information. 
     * 
     * @return Ecs Return a configured ECS client.
     */
    public static function createClient()
    {
        // Create a configuration object.
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), // Obtain the AccessKey ID of a RAM user from an environment variable.
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"), // Obtain the AccessKey secret of the RAM user from an environment variable.
            "endpoint" => "ecs.cn-hangzhou.aliyuncs.com" // Specify the ECS endpoint.
        ]);

        // Create another ECS client based on the preceding configurations.
        return new Ecs($config);
    }
    /**
     * 
     * This function is used to show how to use an SDK client to call the DescribeRegions operation. 
     * You can use this function to create a client, construct a request object, and call the operation. 
     * If the call fails, exceptions are captured and error messages are returned. 
     */
    public static function main()
    {
        // Create an SDK client.
        $client = self::createClient();
        // Create a DescribeRegionsRequest request object and do not specify parameters for the request object.
        $describeRegionsRequest = new DescribeRegionsRequest([]);
        // Create a RuntimeOptions instance and do not specify parameters for the instance.
        $runtime = new RuntimeOptions([]);
        try {
            // Use the describeRegionsWithOptions method in the client to call the operation.
            // The try-catch block is used to capture possible exceptions.
            $result = $client->describeRegionsWithOptions($describeRegionsRequest, $runtime);
            print_r($result);
        } catch (Exception $error) {
            // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
            var_dump($error->message);
        }
    }
}

Sample::main();

Handle exceptions. Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. We recommend that you properly handle exceptions by performing operations such as reporting exceptions, recording logs, and performing retries. This helps ensure the robustness and stability of your system. For more information about how to handle exceptions in SDKs for PHP, see Handle an exception.

<?php

require_once 'vendor/autoload.php';

use AlibabaCloud\SDK\Ecs\V20140526\Ecs;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeRegionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;


class Sample
{
    /**
     * Create an ECS client.
     * You can use this method to initialize and return an ECS client, which can be used to call API operations of ECS. 
     * You can obtain the AccessKey ID and AccessKey secret from environment variables to configure the ECS client. This prevents leakage of sensitive information and ensures secure access to the sensitive information. 
     * 
     * @return Ecs Return a configured ECS client.
     */
    public static function createClient()
    {
        // Create a configuration object.
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), // Obtain the AccessKey ID of a RAM user from an environment variable.
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"), // Obtain the AccessKey secret of the RAM user from an environment variable.
            "endpoint" => "ecs.cn-hangzhou.aliyuncs.com" // Specify the ECS endpoint.
        ]);

        // Create another ECS client based on the preceding configurations.
        return new Ecs($config);
    }
    /**
     * 
     * This function is used to show how to use an SDK client to call the DescribeRegions operation. 
     * You can use this function to create a client, construct a request object, and call the operation. 
     * If the call fails, exceptions are captured and error messages are returned. 
     */
    public static function main()
    {
        // Create an SDK client.
        $client = self::createClient();
        // Create a DescribeRegionsRequest request object and do not specify parameters for the request object.
        $describeRegionsRequest = new DescribeRegionsRequest([]);
        // Create a RuntimeOptions instance and do not specify parameters for the instance.
        $runtime = new RuntimeOptions([]);
        try {
            // Use the describeRegionsWithOptions method in the client to call the operation.
            // The try-catch block is used to capture possible exceptions.
            $result = $client->describeRegionsWithOptions($describeRegionsRequest, $runtime);
            print_r($result);
        } catch (Exception $error) {
            if ($error instanceof TeaError) {
                // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
                print_r("message:" . $error->getMessage() . "\n");
                print_r("code:" . $error->getCode() . "\n");
                print_r($error->data);
            } elseif ($error instanceof TeaUnableRetryError) {
                // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
                print_r($error->getLastException());
            } else {
                // Handle exceptions with caution in actual business scenarios and never ignore exceptions in your project. In this example, the information is displayed for reference only. 
                print_r("message:" . $error->getMessage());
            }
        }
    }
}

Sample::main();