Endpoint

/v2/time/status

GET

Retrieve the time status of the underlying system

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_time_status_v2",
  "type": "object",
  "properties": {
    "config": {
      "description": "config",
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "API_TIME_SOURCE_NTP",
            "API_TIME_SOURCE_HYPERVISOR"
          ],
          "description": "The time source type: For ANQ, must be the hypervisor-provided time source. For all platforms other than CNQ on Azure, must be an NTP server. For CNQ on Azure, can be either an NTP server or the hypervisor-provided time source.:\n * `API_TIME_SOURCE_HYPERVISOR` - API_TIME_SOURCE_HYPERVISOR,\n * `API_TIME_SOURCE_NTP` - API_TIME_SOURCE_NTP"
        },
        "use_ad_for_primary": {
          "description": "Use AD as the primary time source",
          "type": "boolean"
        },
        "ntp_servers": {
          "type": "array",
          "items": {
            "description": "List of NTP servers",
            "type": "string"
          }
        }
      }
    },
    "time": {
      "description": "time",
      "type": "string"
    },
    "node_statuses": {
      "type": "array",
      "items": {
        "description": "node_statuses",
        "type": "object",
        "properties": {
          "node_id": {
            "description": "node_id",
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "TIME_NOT_SYNCHRONIZING",
              "TIME_SYNCHRONIZING"
            ],
            "description": "status:\n * `TIME_NOT_SYNCHRONIZING` - TIME_NOT_SYNCHRONIZING,\n * `TIME_SYNCHRONIZING` - TIME_SYNCHRONIZING"
          }
        }
      }
    }
  }
}