Scaling

URL:
https://<root>/services/<ServiceName>.<ServiceType>/scaling
Methods:
GET
Operations:
Edit Scaling
Required Capability:
Access allowed with either the "Update", "Delete", or "Security and infrastructure" privileges, or the Publisher role
Version Introduced:
10.9

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

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails

type

The GIS service microservice type.

Values: FeatureServer | GeometryServer | GPServer | GPSyncServer | MapServer | TileServer

deploymentId

The microservice ID.

replicas

The number of replicas for the microservice. For manual scaling, the value for both min and max should be the same. Organizations using a version of ArcGIS Enterprise on Kubernetes at 10.9.1 or higher have the option to enable autoscaling. For more information on manual scaling and autoscaling, see the Edit operation.

Example
1
2
3
4
5
"replicas": {
  "min": 3,
  "max": 3,
  "scalingMode": "manual" //Added at 11.0
},

resources

The minimum and maximum resource allocations for the microservice, including the minimum memory (memoryMin) and minimum CPU (cpuMin) resources required for the microservice to start. This property can be updated using the Edit operation.

Example
1
2
3
4
5
6
"resources": {
  "memoryMin": "500Mi",
  "cpuMin": "0.125",
  "memoryMax": "8Gi",
  "cpuMax": "4"
}

Example usage

The following is a sample request URL used to access the scaling resource:

1
https://organization.domain.com/context/admin/services/MyService.MapServer/scaling?f=pjson

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "scalingSpec": [
    {
      "deploymentType": "MapServer",
      "replicas": {
        "min": 3,
        "max": 3,
        "scalingMode": "manual"
      },
      "deploymentId": "kui6zmtqzkjrsihh6tegq",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "2Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close