API client / Methods / MultiClusters
Required API Key: Admin
Method signature
$client->assignUserId(string userID, string clusterName)

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

About this method # A

Assign or Move a userID to a cluster.

The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Examples # A

Assign a user to a cluster#

1
$client->assignUserId('myUserID1', 'c1-test');

Parameters # A

Parameter Description
userID #
type: string
Required

userID to assign.

If userID is unknown, we will assign the userID to the cluster, otherwise the operation will move the userID and its associated data from its current cluster to the new one specified in parameter 2.

If you have already called this method, and it is still running, you will not be able to run this method again for the same userID, until the first has finished. Any attempt will be rejected. it will be rejected.

The userID can contain:

  • alphanumeric caracters
  • -
  • .
  •   (space)
  • *
clusterName #
type: string
Required

Cluster name.

Response # A

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
{
  "createdAt": "2013-01-18T15:33:13.556Z"
}
Field Description
createdAt #
string

Date at which the indexing job has been created.

Did you find this page helpful?
PHP v3