- URL:
- https://<root>/data/<datastoreID>/config/placementPolicy
- Methods:
GET- Operations:
- Edit Placement Policy
- Version Introduced:
- 12.0
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The placement resource returns the current node affinity and tolerations that are applied to a system-managed datastore’s pods. By utilizing node affinity and tolerations, administrators can have the pods for a specific datastore be scheduled to, or repelled from, specific nodes. For example, an administrator could use node affinity and tolerations to ensure that a datastore’s pods are scheduled to nodepools that have higher capacity, ensure that datastore workloads are scheduled in preferred availability zones (AZ), or create separate reserved node instances for datastores. The placement resource also provides access to the Edit Placement Policy operation, which is used to define or modify the node affinity and toleration values for a specific datastore.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the placement resource:
https://organization.example.com/<context>/admin/data/<datastoreID>/config/placementPolicy?f=pjsonJSON Response example
The following response example shows a sample configuration for node:
{
"dataStoreType": "nosql",
"dataStoreId": "642a7c9dd0ce05f1bcbed9142510a2a5",
"placementPolicy": {
"tolerations": [],
"nodeAffinity": {
"requiredDuringSchedulingIgnoredDuringExecution": {
"nodeSelectorTerms": [
{
"matchExpressions": [
{
"key": "sampleLabel",
"operator": "In",
"values": [
"sampleValue"
]
}
]
}
]
}
}
}
}The following response example shows a sample configuration for tolerations:
{
"dataStoreId": "642a7c9dd0ce05f1bcbed9142510a2a5",
"dataStoreType": "nosql",
"placementPolicy":{
"nodeAffinity":{},
"tolerations": [
{
"effect": "NoSchedule",
"key": "label1",
"operator": "Equal",
"value": "test1"
}
]
}
}