API client / Methods / MultiClusters
Required API Key: Admin
Method signature
$client->hasPendingMappings([
    // All the following parameters are optional
    'retrieveMappings' => bool,
]);

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Get the status of your clusters’ migrations or user creations.

Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it’s done.

Examples

Read the Algolia CLI documentation for more information.

Has pending mappings

1
$client->hasPendingMappings(true);

Parameters

retrieveMappings
type: boolean
default: false
Optional

When true, the API returns an object with all pending migrations for each cluster. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

1
2
3
4
5
6
7
8
9
10
11
{
  "pending": true,
  "clusters": {
    "cluster_1": [
      'user1',
      'user2',
      'user...',
      'user99999'
    ]
  }
}
pending
boolean

Whether there are any pending migrations on your cluster.

clusters
object

Only returned when the retrieveMappings parameter is set to true. The objects’ keys are the names of clusters with a pending status, the values are arrays of strings containing the mapping IDs that are currently pending.

Did you find this page helpful?