- URL:
- https://<root>/services/<ServiceName>.<ServiceType>/scaling
- Methods:
GET- Operations:
- Edit Scaling
- Version Introduced:
- 10.9
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 scaling resource returns the scaling and resource allocation for a specific GIS service microservice. Some of the properties can be updated using the Edit operation. All of the microservice's properties can be viewed through the Deployment resource.
Request parameter
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Response properties
| Property | Details |
|---|---|
| The GIS service microservice type. Values: |
| The microservice ID. |
| The number of replicas for the microservice. For manual scaling, the value for both Example |
| The minimum and maximum resource allocations for the microservice, including the minimum memory ( Example |
Example usage
The following is a sample request URL used to access the scaling resource:
https://organization.example.com/<context>/admin/services/MyService.MapServer/scaling?f=pjsonJSON Response example
{
"scalingSpec": [
{
"deploymentType": "MapServer",
"replicas": {
"min": 3,
"max": 3,
"scalingMode": "manual"
},
"deploymentId": "kui6zmtqzkjrsihh6tegq",
"resources": {
"memoryMin": "500Mi",
"memoryMax": "2Gi",
"cpuMin": "0.125",
"cpuMax": "2"
}
}
]
}