Search | ArcGIS REST APIs | Esri Developer

URL:: https://<root>/info/search
Methods:: GET
Version Introduced:: 12.0

Description

The search resource outputs information regarding the health of the opensearch cluster used by ArcGIS Video Server. ArcGIS Video Server utilizes a spatiotemporal big data store as an opensearch cluster, allowing users to run search operations through the REST API.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. The default value is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The output format for this operation. The default value is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Response properties

Property	Details
`coverage-extent`	The `coverage-extent` property provides detailed information regarding services currently covered by the opensearch cluster.
`health`	The `health` property outputs detailed information regarding the current status of the opensearch cluster, including the spatiotemporal big data store currently being used as the cluster.

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com:21443/arcgis/admin/info/search?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
    "coverage-extent": {
        "pri.store.size": "23.2kb",
        "docs.deleted": "0",
        "pri": "1",
        "health": "yellow",
        "index": "c55a5964-6622-45a9-80e7-051439257129-vs-coverage-extent-index-1",
        "rep": "1",
        "uuid": "YM8PJC8bTKuIPb4xxvY8tA",
        "store.size": "23.2kb",
        "docs.count": "3",
        "status": "open"
    },
    "health": {
        "cluster": "bds_wynb7v2u",
        "init": "0",
        "node.total": "1",
        "relo": "0",
        "pri": "16",
        "epoch": 1767723092,
        "discovered_cluster_manager": "true",
        "unassign": "14",
        "shards": "16",
        "active_shards_percent": "53.3%",
        "pending_tasks": "0",
        "max_task_wait_time": "-",
        "node.data": "1",
        "status": "yellow",
        "timestamp": "18:11:32"
    }
}