- URL:
- https://<root>/data/<datastoreID>/config/volumes/status
- Methods:
GET- Version Introduced:
- 11.3
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 status resource returns the real-time status and events for the PersistentVolumeClaim (PVC) for a system-managed object, spatiotemporal, or relational data store from within the last 60 minutes, including the events from any volume expansions being performed on the pods pertaining to the PVC.
This resource only returns events from a volume expansion until either a new volume expansion occurs or 60 minutes have passed. If another volume expansion is performed, the status resource will update to show the events of the most recent volume expansion. After that point, information for previous volume expansions can be found in the logs. After 60 minutes, the status resource will no longer include volume expansion events.
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 status resource:
https://organization.example.com/<context>/admin/data/2eca8ba5-ad4e-4798-bbe5-ea27db7e04e84/config/volumes/status?f=pjsonJSON Response example
{
"datastoreId": "2eca8ba5-ad4e-4798-bbe5-ea27db7e04e84",
"datastoreType": "objectStore",
"deployments": [
{
"type": "ObjectStore",
"name": "arcgis-object-store-xxxxx-xxxxx",
"mode": "Mixed",
"volumes": [
{
"spec": {
"accessModes": [ "ReadWriteOnce"],
"resources": {
"limits": {},
"requests": {
"storage": "32Gi"
}
},
"storageClassName": "arcgis-storage-default",
"volumeMode": "Filesystem"
},
"kind": "PersistentVolumeClaim",
"purpose": "data-volume",
"persistentVolumeClaims": [
{
"name": "data-volume-arcgis-object-store-xxxxx-xxxxx",
"requestedCapacity": "32Gi",
"actualCapacity": "32Gi"
},
{
"name": "data-volume-arcgis-object-store-xxxxx-xxxxx",
"requestedCapacity": "32Gi",
"actualCapacity": "32Gi"
},
{
"name": "data-volume-arcgis-object-store-xxxxx-xxxxx",
"requestedCapacity": "32Gi",
"actualCapacity": "32Gi"
}
]
}
]
}
]
}