Alibaba Cloud SDK:Chamadas genéricas

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.  
  

Parâmetros específicos da operação

A maneira como se passa um parâmetro de solicitação depende dos metadados da operação de api. Por exemplo, a operação DescribeInstanceStatus está definida como {"name":"RegionId","in":"query",...}} nos metadados. Nesse caso, "in":"query" indica que o ID da região (RegionId) deve ser passado em 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();

Exemplo: Chamar uma operação de api estilo 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();

Perguntas frequentes

1. O que fazer se a mensagem de erro "Fatal error: Uncaught AlibabaCloud\Client\Exception\ClientException: AccessKey ID cannot be empty inXXX" for retornada?

   Causa: O par de AccessKey não está configurado corretamente.

   Soluções:

   1. Execute os comandos abaixo para verifique se as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET estão configuradas.

      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%

      Se um par de AccessKey válido for retornado, as variáveis de ambiente estarão configuradas corretamente. Caso nenhum par de AccessKey ou um par inválido seja retornado, configure as variáveis de ambiente conforme necessário. Para mais informações, consulte Configure variáveis de ambiente no Linux, macOS e Windows.

   2. Verifique se há erros relacionados ao par de AccessKey no código.

      Exemplo de solicitação com erro:

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

      Nota

      No exemplo de solicitação com erro acima, os valores de entrada de getenv() são usados como o par de AccessKey. No entanto, essa função serve para ler valores das variáveis de ambiente. Após definir os nomes das variáveis de ambiente como ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET na sua máquina, o getenv poderá ler os valores dessas variáveis.

      Exemplo de solicitação bem-sucedida:

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