- URL:
- https://<root>/system/deployments/<deploymentID>
- Methods:
GET- Operations:
- Edit, Refresh Deployment
- Child Resources:
- Status
- 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
An individual deployment resource returns a list of properties for an individual microservice. Some of these properties can be updated using the Edit.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Response properties
| Property | Details |
|---|---|
| The microservice mode. A mode type of Values: |
| The microservice provider. Only microservices related to an ArcGIS service type have a provider type. A provider type of Values: |
| The microservice ID. |
| The microservice name. |
| The microservice type. For example, if the microservice is a shared feature server containing feature services, Values: |
| The JSON object representation of the template's specifications, including replicas, container resources, and managed Kubernetes resources. At ArcGIS Enterprise 11.2 on Kubernetes, the JSON object can also include the Example |
| The number of replicas for the microservice. For manual scaling, the values for both Example |
| Introduced at 11.2. The node affinity or tolerations applied to the pods of a GIS service deployment. For more information on node affinity and tolerations, see the Edit placement policy operation. Example |
| Introduced at 11.2. An array that sets additional volumes for the deployment's pods to pull from. Administrators have the option to configure PVC volumes, which create a singular PVC volume that the pods of a deployment can directly request resources from, or configure PVC volume templates with the deployment, which will create separate volumes for each pod to use. For singular PVC volumes, administrators will only need to provide the volume's ID: Example For PVC volume templates, administrators need to provide the volume template's ID as well as the volume's purpose. The purpose specifies the types of volumes being created. Currently, the only supported purpose is Example |
| The minimum and maximum resource allocations for the microservice, including the minimum memory ( Example |
| The date, in milliseconds from epoch format, of the latest revision to the template. Example |
Example usage
The following is a sample request URL used to access an individual deployment resource:
https://organization.example.com/<context>/admin/system/deployments/v4b257669-f2ee-4b14-a058-30ade76e6127?f=pjsonJSON Response example
The following is a sample JSON response for the ingress controller microservice:
{
"mode": "Undefined",
"configuredState": "STARTED",
"provider": "Undefined",
"deploymentId": "ky6vk601p5ltq41sra837",
"name": "ingress-controller",
"type": "System",
"spec": {
"replicas": {
"min": 3,
"max": 3,
"scalingMode": "manual"
},
"containers": [
{
"name": "main-container",
"resources": {
"memoryMin": "256Mi",
"memoryMax": "4Gi",
"cpuMin": "0.125",
"cpuMax": "1"
},
"containerImageUrl": "contanier.image.com/info:1082",
"containerImageKey": "INGRESS_CONTROLLER"
}
],
"managedKubernetesResources": [
{
"purpose": "blue-deployment",
"kind": "Deployment",
"name": "arcgis-ingress-controller",
"selectorInstanceName": "blue"
},
{
"purpose": "service",
"kind": "Service",
"name": "arcgis-ingress-nginx",
"selectorInstanceName": "blue"
}
]
},
"labels": {},
"revision": 1618226994937
}The following is a sample JSON response for a shared map service:
{
"mode": "Shared",
"configuredState": "STARTED",
"provider": "DMaps",
"deploymentId": "kvymoiqt0cl52ldoma1fh",
"name": "shared-mapserver",
"type": "MapServer",
"spec": {
"servicesFilter": {
"serviceType": "MapServer",
"providerType": "DMaps"
},
"replicas": {
"min": 3,
"max": 3,
"scalingMode": "manual"
},
"podPlacementPolicy": {
"tolerations": [{"effect": "NoSchedule","key": "label1","operator": "Equal","value": "test1"}]
"nodeAffinity": {}
},
"volumes": [
{
"volumeId": "uadwuaj4pwkjhcst6spxx"
}
],
"containers": [
{
"name": "main-container",
"resources": {
"memoryMin": "500Mi",
"memoryMax": "4Gi",
"cpuMin": "0.125",
"cpuMax": "2"
},
"containerImageUrl": "container.image.com/info:1082",
"containerImageKey": "MAP_SERVER"
},
{
"name": "filebeat",
"resources": {
"memoryMin": "32Mi",
"memoryMax": "50Mi",
"cpuMin": "0.05",
"cpuMax": "0.25"
},
"containerImageUrl": "container.image.com/info:1082",
"containerImageKey": "FILEBEAT"
}
],
"initServices": {
"serviceNames": [
{
"serviceType": "MapServer",
"folderName": "System",
"serviceName": "SharedMapServiceHost",
"serviceId": "sf8xiz33q3g7b4o18bcrf"
}
]
},
"managedKubernetesResources": [
{
"purpose": "blue-deployment",
"kind": "Deployment",
"name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver-z9nlp",
"selectorInstanceName": "blue"
},
{
"purpose": "service",
"kind": "Service",
"name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver",
"selectorInstanceName": "blue"
}
]
},
"labels": {},
"revision": 1618228766421
}