Alibaba Cloud SDK:Appels génériques

composer require alibabacloud/client

use AlibabaCloud\Client\AlibabaCloud;   

   // getenv indicates that the AccessKey pair obtained from environment variables is used to initialize the client.
    AlibabaCloud::accessKeyClient(
         getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
         getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
    )
    ->regionId('cn-hangzhou') // Specify the region ID.
    ->asDefaultClient(); // Specify the client as the default client.  
  

Paramètres spécifiques à l'opération

Les métadonnées de l'opération d'API déterminent la méthode de transmission d'un paramètre de requête. Par exemple, l'opération d'API DescribeInstanceStatus est définie comme {"name":"RegionId","in":"query",...}} dans les métadonnées. Ici, "in":"query" indique que l'ID de région (RegionId) doit être transmis dans options([ 'query' => [ 'key1' => 'value1'] ]).

        // The query parameters when they are of the collection type.
        $instanceIDs = ["i-bp1axhql4dqXXXXXXXX", "i-bp124uve8zqXXXXXXXX"];
        // Common parameters.
        $queryParams = [
            'RegionId' => 'cn-hangzhou',
            'PageNumber' => 1,
            'PageSize' => 30,
        ]; 
        // Process the collection parameters by converting them to the format of InstanceId.1, InstanceId.2.
        foreach ($instanceIDs as $index => $id) {
            $queryKey = 'InstanceId.' . ($index + 1);
            $queryParams[$queryKey] = $id;
        }
 // Configure the basic information about and request parameters of the API operation.
 $result = AlibabaCloud::rpc() // The API operation style, such as remote procedure call (RPC) and resource-oriented architecture (ROA). 
                // 1.Configure the basic information about the API operation.
                ->host('ecs.cn-hangzhou.aliyuncs.com') 
                ->product('Ecs') // The service name.
                ->version('2014-05-26') // Make sure that the version number must be the same as that in the API reference.
                ->action('DescribeInstanceStatus') // The name of the API operation. When you call an RPC-style API operation, you must configure action() to specify the name of the API operation.
                ->method('POST') // The request method. Valid values: GET and POST.
                ->setProtocolType('HTTPS') // The request protocol. Valid values: HTTP and HTTPS. We recommend that you use HTTPS. 
                // ->pathPattern()  // The resource path, which is required by ROA-style API operations. Do not configure this parameter for RPC-style API operations. 
                // 2.Configure the request parameters.
                ->options([
                    // Scenario 1: Configure query parameters.
                    'query' => $queryParams
                    
                    // Scenario 2: Configure the request body in form_params.
                    // 'form_params' => [ 
                    //     'key1' => 'value1',
                    //     'key2' => 'value2',
                    //     'key3' => 'value3',
                    // ],
                ])
  

 // Call an RPC-style API operation.
 $result = AlibabaCloud::rpc()
           ->request()
 // Call an ROA-style API operation. 
 // $result = AlibabaCloud::roa() 
 //         ->request()        
 // If the response is of the byte type, the request ID and response parameters are returned.          
 print_r($result->toArray());       

<?php

namespace AlibabaCloud\SDK\Sample;
require_once 'vendor/autoload.php';
use AlibabaCloud\Tea\Utils\Utils;
use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Exception\ServerException;

class Sample
{   
    public static function main()
    {

    // getenv indicates that the AccessKey pair obtained from environment variables is used to initialize the client.
    AlibabaCloud::accessKeyClient(
         getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
         getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
    )
    ->regionId('cn-hangzhou') // Specify the region ID.
    ->asDefaultClient(); // Specify the client as the default client.

        // Configure query parameters when they are of the collection type.
        $instanceIDs = ["i-bp1axhql4dqXXXXXXXX", "i-bp124uve8zqXXXXXXXX"];
        // Common parameters.
        $queryParams = [
            'RegionId' => 'cn-hangzhou',
            'PageNumber' => 1,
            'PageSize' => 30,
        ]; 
        // Process the collection parameters by converting them to the format of InstanceId.1, InstanceId.2.
        foreach ($instanceIDs as $index => $id) {
            $queryKey = 'InstanceId.' . ($index + 1);
            $queryParams[$queryKey] = $id;
        }
        try {
            $result = AlibabaCloud::rpc()
                ->method('POST') // The request method.
                ->verify(false) // Disable certification authentication.
                ->debug(true)  // Enable logging.
                ->setProtocolType('HTTPS') // Configure a protocol.
                ->host('ecs.cn-hangzhou.aliyuncs.com') // Configure the endpoint.
                ->version('2014-05-26') // Make sure that the version number must be the same as that in the API reference.
                ->action('DescribeInstanceStatus') // Specify the API operation name.
                // Configure request parameters.
                ->options([
                    'query' => $queryParams
                ])
                // Send the request.
                ->request();
            print_r($result->toArray());
        } catch (ClientException | ServerException $e) {
            echo $e->getErrorMessage();
        } catch (ServerException $exception) {
            print_r($exception->getErrorMessage());
        }
}
}

Sample::main();

Exemple : Appeler une opération d'API de style RESTful (ROA)

<?php
namespace AlibabaCloud\SDK\Sample;
require_once 'vendor/autoload.php';
use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Exception\ServerException;

class Sample
{
  public static function main()
    {
    try {
        $result = AlibabaCloud::roa()
                          ->regionId('cn-hangzhou) // The region ID. If this parameter is not specified, the region of the client or the default region is used. 
                          ->product('CS') // The service name. 
                          ->version('2015-12-15 ') // The service version. 
                          ->serviceCode('cs') // The service code for addressing. This parameter is optional. 
                          ->endpointType('openAPI') // The endpoint type. This parameter is optional. 
                          ->method('GET') // The request method. 
                          ->host('cs.aliyun.com ') // The domain name. If this parameter is specified, addressing is not performed. If a service uses bearer tokens for authentication, you must specify the domain name. 
                          ->pathPattern('/api/v1/clusters') // The URL of the API operation. When you call an ROA-style API operation, you must configure pathPattern() to specify the complete URL of the API operation. You can obtain the URL of an API operation from the API metadata. 
                          ->request(); // Initiate the request and obtain the result. This parameter must be at the end of the settings. 
    print_r($result->toArray());
    } catch (ClientException $exception) {
    print_r($exception->getErrorMessage());
    } catch (ServerException $exception) {
    print_r($exception->getErrorMessage());
}
    }
}
Sample::main();

FAQ

1. Que faire si le message d'erreur « Fatal error: Uncaught AlibabaCloud\Client\Exception\ClientException: AccessKey ID cannot be empty inXXX » s'affiche ?

   Cause : la paire d'AccessKey est mal configurée.

   Solutions :

   1. Exécutez les commandes suivantes pour vérifier la configuration des variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET.

      Linux/macOS

      echo $ALIBABA_CLOUD_ACCESS_KEY_ID
      echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

      Windows

      echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
      echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

      Si une paire d'AccessKey valide s'affiche, les variables d'environnement sont correctement configurées. Sinon, configurez-les selon vos besoins. Pour plus d'informations, consultez Configurer les variables d'environnement sous Linux, macOS et Windows.

   2. Vérifiez les erreurs liées à la paire d'AccessKey dans le code.

      Exemple de requête incorrecte :

      AlibabaCloud::accessKeyClient(
               getenv('yourAccessKeyID'),
               getenv('yourAccessKeySecret')
          )

      Remarque

      Dans l'exemple ci-dessus, les valeurs passées à getenv() servent directement de paire d'AccessKey. Or, cette fonction lit les valeurs depuis les variables d'environnement. Une fois les variables d'environnement nommées ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET définies sur votre machine, getenv peut en récupérer les valeurs.

      Exemple de requête correcte :

      AlibabaCloud::accessKeyClient(
               getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'),
               getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET')
          )