OpenSearch:Query the application list

Prérequis

Avant de commencer, assurez-vous d'avoir :

• Un compte Alibaba Cloud disposant d'applications Open Search créées

• Le SDK PHP installé. Pour les instructions d'installation, consultez la documentation du SDK.

• Un utilisateur RAM (Resource Access Management) auquel votre compte Alibaba Cloud a attribué le rôle AliyunServiceRoleForOpenSearch. Consultez les rubriques AliyunServiceRoleForOpenSearch et Règles d'autorisation d'accès.

Définir les variables d'environnement

Définissez les variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET avec l'ID de clé AccessKey et le secret de clé AccessKey de votre utilisateur RAM.

Linux et macOS

export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

Windows

1. Créez un fichier de variables d'environnement et ajoutez-y les variables ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET avec leurs valeurs respectives.

2. Redémarrez Windows pour que les modifications prennent effet.

Créer un fichier de configuration

Créez le fichier Config.inc.php contenant la configuration du client. Ce fichier initialise l'objet OpenSearchClient utilisé par toutes les opérations ultérieures du SDK.

<?php
// Import the autoloader.
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

// Read credentials from environment variables.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$secret      = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');

// Replace with your region endpoint.
// Find the endpoint on the Basic Information page of your application in the console.
$endPoint = '<region endPoint>';

// Replace with your application name.
$appName = '<app name>';

// Replace with your drop-down suggestion model name.
$suggestName = '<suggest name>';

// Enable debug mode to print trace information.
$options = array('debug' => true);

// Create the client.
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);

Remplacez les espaces réservés suivants :

Interroger la liste des applications

Le code suivant interroge toutes les applications de votre compte via une requête paginée. Il utilise la méthode AppClient.listAll() avec un objet Pageable pour contrôler la page de résultats et sa taille.

<?php
// Import the configuration file.
require_once("Config.inc.php");
use OpenSearch\Client\AppClient;
use OpenSearch\Generated\Common\Pageable;

// Set pagination: retrieve the first page with up to 10 results.
$pageable = new Pageable(array('page' => 1, 'size' => 10));

// Create an AppClient using the shared client from Config.inc.php.
$appClient = new AppClient($client);

// Retrieve and print the application list.
$ret = $appClient->listAll($pageable);
print_r($ret);

// Print trace information for debugging.
echo $ret->traceInfo->tracer;

Paramètres de pagination

Pour récupérer la page suivante, incrémentez la valeur de page de 1 et appelez à nouveau la méthode listAll().

Champs de réponse

L'objet $ret renvoyé par la méthode listAll() inclut les champs suivants :