ECS PHP V2.0 SDK調用樣本 - Elastic Compute Service

本文以調用查詢一台或多台ECS執行個體的詳細資料（DescribeInstances）介面為例，為您介紹PHP V2.0 SDK的安裝和使用。

前提條件

由於阿里雲帳號（主帳號）擁有資源的所有許可權，其AccessKey一旦泄露風險巨大，所以建議您使用滿足最小化許可權需求的RAM使用者的AccessKey。具體操作方式請參見建立AccessKey。
給RAM使用者授予操作Elastic Compute Service相關資源的許可權。本文提供的範例程式碼為查詢樣本，所以選擇AliyunECSReadonlyAccess系統權限原則，您在使用的時候可以根據業務需求進行自訂授權。
1. 使用自訂權限原則。
  關於如何建立自訂權限原則，請參見建立自訂權限原則和授權資訊。
  Elastic Compute Service依據最佳實務提供了一些自訂權限原則樣本，您可以參考這些樣本以快速建立符合自身業務需求的自訂權限原則，具體詳情請參見Elastic Compute Service自訂權限原則參考。
2. 使用系統權限原則。
  Elastic Compute Service支援的所有系統權限原則及其對應的許可權描述，請參見Elastic Compute Service系統權限原則參考。
在環境變數中配置AccessKey，具體操作步驟請參見在Linux、macOS和Windows系統配置環境變數。

安裝SDK

PHP V2.0 SDK安裝方式請參見SDK中心。您可以直接複製下方提供的安裝命令在Terminal中執行，以完成ECS SDK的安裝：

composer require alibabacloud/ecs-20140526 4.3.0

使用SDK

1. 初始化用戶端

阿里雲SDK支援多種訪問憑據用於初始化用戶端，例如AccessKey和STS Token等，更多方式請參見管理訪問憑據。本樣本以通過AccessKey初始化用戶端為例。

<?php

require_once 'vendor/autoload.php';
use AlibabaCloud\SDK\Ecs\V20140526\Ecs;
use Darabonba\OpenApi\Models\Config;

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"),
            "endpoint" => "ecs.cn-hangzhou.aliyuncs.com",
        ]);
        return new Ecs($config);
    }
}

2. 構建介面的請求對象

在構建請求對象之前，請查看該介面的API文檔擷取參數資訊。

說明

請求對象命名規則：{API名稱}Request，例如DescribeInstances該介面的請求對象為DescribeInstancesRequest。

// 構造請求對象
$describeInstancesRequest = new DescribeInstancesRequest([
     "regionId" => "cn-beijing"
]);

3. 發起調用

通過用戶端調用OpenAPI時，支援設定運行時參數，例如逾時配置、代理配置等，更多資訊請查看進階配置。

說明

介面返回對象命名規則：{API名稱}Response，例如DescribeInstances該介面的返回對象為DescribeInstancesResponse。

// 建立運行時設定物件
$runtime = new RuntimeOptions();
// 發起請求  
$describeInstancesResponse = $client->describeInstancesWithOptions($describeInstancesRequest, $runtime);

4. 異常處理

PHP SDK將異常進行了細緻的分類，主要劃分為以下幾個：

TeaUnableRetryError：該異常主要是因為網路問題造成，一般是網路問題造成達到最大重試次數後拋出，可以通過getLastException來查詢錯誤發生時的請求資訊。
TeaError：在SDK的請求中主要以業務報錯為主的異常。

建議採取合理的措施來處理異常，比如合理地傳播異常、記錄日誌、嘗試恢複等，以確保系統的健壯性和穩定性。

5. 完整樣本

<?php

require_once 'vendor/autoload.php';
use AlibabaCloud\SDK\Ecs\V20140526\Ecs;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Ecs\V20140526\Models\DescribeInstancesRequest;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Exception\TeaUnableRetryError;

class Sample
{

    public static function main()
    {
        try {
            $config = new Config([
                "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
                "endpoint" => "ecs.cn-beijing.aliyuncs.com", // <endpoint>
            ]);
            $client = new Ecs($config);

            // 構造請求對象
            $describeInstancesRequest = new DescribeInstancesRequest([
                "regionId" => "cn-beijing"
            ]);
            // 建立運行時設定物件
            $runtime = new RuntimeOptions();
            // 發起請求  
            $describeInstancesResponse = $client->describeInstancesWithOptions($describeInstancesRequest, $runtime);
            var_dump($describeInstancesResponse);
        } catch (\Exception $error) {
            if ($error instanceof TeaError) {
                // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
                print_r("message:" . $error->getMessage() . "\n");
                print_r("code:" . $error->getCode() . "\n");
                print_r($error->data);
            } elseif ($error instanceof TeaUnableRetryError) {
                // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
                print_r($error->getLastException());
            } else {
                // 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
                print_r("message:" . $error->getMessage());
            }
        }
    }
}
Sample::main();

Elastic Compute Service：ECS PHP V2.0 SDK調用樣本