- URL:https://<root>/system/deployments/findDeployments
- Required Capability:Default administrator role | Security and infrastructure
- Version Introduced:10.9
Description
Legacy:
This operation has been deprecated with the release of ArcGIS Enterprise on Kubernetes 10.9.1.
This operation queries and returns a list of microservices within ArcGIS Enterprise on Kubernetes. The results can be fine-tuned by specifying the name, type, ID, provider, and mode of a microservice. These filters are optional; if no filter is applied, all microservices are returned in the response.
Request parameters
Parameter | Details |
---|---|
filterName | The name of the microservice. |
filterType | The microservice type. For example, if the microservice is a shared feature server containing feature services, the type will be FeatureServer. Values: FeatureServer | GeometryServer | GPServer | GPSyncServer | MapServer | TileServer | System | InMemoryStore | ObjectStore | SpatiotemporalIndexStore | QueueServer | RelationalStore |
filterId | The microservice ID. |
filterProvider | The microservice provider. Only microservices related to an ArcGIS service type will have a provider type. A provider type of Undefined is used for nonservice-related microservices (Admin API, portal sharing, ingress controller, and so on). Values: SDS | ArcObjects11 | DMaps | Undefined | Postgres | Tiles | Ignite | MinIO | Elasticsearch | RabbitMQ |
filterMode | The microservice mode. A mode type of Undefined is used when the microservices is system related (Admin API, portal sharing, ingress controller, and so on). Only microservices related to an ArcGIS service type use either the Dedicated or Shared value for this parameter. Values: Shared | Dedicated | Undefined | Primary | Standby | Coordinator |
| The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the findDeployments operation:
POST /context/admin/system/deployments/findDeployments HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filterName=&filterType=MapServer&filterId=&filterProvider=&filterMode=Dedicated&f=pjson&token=IPr9cuksbZyZ9f4dmIL_V8h5_7kz18zi7Qgf7jB3KhsRZ7b364HvOptzZfup4l1GS-1WbS30xBjT23_dkNG5-iRgFDlaCaSLFu9O9YDbLapE_LgFKqeO-zHvA1JJwLdHjv0Bbqu5VD7AfM0KY7uchg9n5B5SZmPa-o8rTpU5cSNsxZMc3oILjRCNkZY3y4pim9o6GDolZyMHQSB7B2AvwN_44SFwWzvFMBCaoSqVe4czoCVItJA0eEuHAtrK3UhO
The following is a sample GET request for the findDeployments operation:
https://organization.domain.com/context/admin/system/deployments/findDeployments?f=System
JSON Response example
The JSON response below is returned when query results were filtered to return Dedicated MapServer microservices.
{
"filteredDeployments": [
{
"mode": "Dedicated",
"configuredState": "STARTED",
"provider": "ArcObjects11",
"deploymentId": "kfvj4tic5kej1s3sl4vpg",
"name": "sampleworldcities-mapserver",
"type": "MapServer",
"spec": {
"servicesFilter": {
"serviceType": "MapServer",
"folderName": "",
"serviceId": "scl2e95kguz41lgjw7ugg",
"serviceName": "SampleWorldCities",
"providerType": "ArcObjects11"
},
"replicas": {
"min": 1,
"max": 1
},
"containers": [
{
"name": "main-container",
"resources": {
"memoryMin": "500Mi",
"memoryMax": "2Gi",
"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"
}
],
"managedKubernetesResources": [
{
"purpose": "blue-deployment",
"kind": "Deployment",
"name": "arcgis-kfvj4tic5kej1s3sl4vpg-mapserver-bev7j",
"selectorInstanceName": "blue"
},
{
"purpose": "service",
"kind": "Service",
"name": "arcgis-kfvj4tic5kej1s3sl4vpg-mapserver",
"selectorInstanceName": "blue"
}
]
},
"labels": {},
"revision": 1618227747937
},
{
"mode": "Shared",
"configuredState": "STARTED",
"provider": "DMaps",
"deploymentId": "kvymoiqt0cl52ldoma1fh",
"name": "shared-mapserver",
"type": "MapServer",
"spec": {
"servicesFilter": {
"serviceType": "MapServer",
"providerType": "DMaps"
},
"replicas": {
"min": 1,
"max": 1
},
"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
}
]
}