OpenSearch:Query the application list

Prerequisites

Before you begin, ensure that you have:

• An Alibaba Cloud account with Open Search applications created

• The PHP SDK installed. For installation instructions, see the SDK documentation.

• A Resource Access Management (RAM) user with the AliyunServiceRoleForOpenSearch role granted by your Alibaba Cloud account. See AliyunServiceRoleForOpenSearch and Access authorization rules.

Set environment variables

Set the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables to the AccessKey ID and AccessKey secret of your RAM user.

Linux and macOS

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

Windows

1. Create an environment variable file and add ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET with their respective values.

2. Restart Windows for the changes to take effect.

Create a configuration file

Create Config.inc.php with the client configuration. This file initializes the OpenSearchClient object used by all subsequent SDK operations.

<?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);

Replace the following placeholders:

Query the application list

The following code queries all applications in your account using a paginated request. It uses AppClient.listAll() with a Pageable object to control the result page and size.

<?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;

Pagination parameters

To retrieve the next page, increment page by 1 and call listAll() again.

Response fields

The $ret object returned by listAll() includes the following fields: