Get Cluster ActiveGate details
Gets details about the specified ActiveGate.
The request produces an application/json
payload.
Authentication
To execute this request, you need the Service Provider API (ServiceProviderAPI
) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.
Endpoint
/api/cluster/v2/activeGates/{agId}
The ID returned for the Cluster ActiveGate v2 endpoint is a hexadecimal representation of the node ID. If you want to use the ID in other endpoints that require the entity ID—for example, v1 endpoints with /api/v1.0/onpremise/sslCertificate
—you need to convert it to the decimal representation of the entity ID.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
agId | string | The ID of the required ActiveGate. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Active | Success |
404 | ErrorEnvelope | Not found. See response body for details. |
Response body objects
The ActiveGate
object
Parameters of the ActiveGate.
Element | Type | Description |
---|---|---|
id | string | The ID of the ActiveGate. |
networkAddresses | string[] | A list of network addresses of the ActiveGate. |
loadBalancerAddresses | string[] | A list of Load Balancer addresses of the ActiveGate. |
osType | string | The OS type that the ActiveGate is running on. |
autoUpdateStatus | string | The current status of auto-updates of the ActiveGate. |
offlineSince | integer | The timestamp since when the ActiveGate is offline. The |
version | string | The current version of the ActiveGate in the |
type | string | The type of the ActiveGate. |
hostname | string | The name of the host the ActiveGate is running on. |
mainEnvironment | string | The ID of the main environment for a multi-environment ActiveGate. |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
autoUpdateSettings | Active | Configuration of the ActiveGate auto-updates. |
networkZone | string | The network zone of the ActiveGate. |
group | string | The group of the ActiveGate. |
modules | Active | A list of modules of the ActiveGate. |
containerized | boolean | ActiveGate is deployed in container ( |
connectedHosts | Active | Information about hosts currently connected to the ActiveGate |
The ActiveGateAutoUpdateConfig
object
Configuration of the ActiveGate auto-updates.
Element | Type | Description |
---|---|---|
setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to |
effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to |
The ActiveGateModule
object
Information about ActiveGate module
Element | Type | Description |
---|---|---|
misconfigured | boolean | The module is misconfigured ( |
version | string | The version of the ActiveGate module. |
type | string | The type of ActiveGate module. |
attributes | object | The attributes of the ActiveGate module. |
enabled | boolean | The module is enabled ( |
The ActiveGateConnectedHosts
object
Information about hosts currently connected to the ActiveGate
Element | Type | Description |
---|---|---|
number | integer | The number of hosts currently connected to the ActiveGate |
Response body JSON model
{
"id": "0x3efdd091",
"networkAddresses": [
"string"
],
"loadBalancerAddresses": [
"string"
],
"osType": "WINDOWS",
"autoUpdateStatus": "OUTDATED",
"offlineSince": 1582031917814,
"version": "1.185.0.20200201-120000",
"type": "ENVIRONMENT",
"hostname": "exampleHostname",
"mainEnvironment": "d1bf4a7e-666b-43af-9f45-718g98372e2f",
"environments": [
"string"
],
"autoUpdateSettings": {
"setting": "INHERITED",
"effectiveSetting": "ENABLED"
},
"networkZone": "exampleNetworkZone",
"group": "default",
"modules": [
{
"misconfigured": true,
"version": "string",
"type": "KUBERNETES",
"attributes": {},
"enabled": true
}
],
"containerized": true,
"connectedHosts": {
"number": 150
}
}
Example
In this example, the request lists the parameters of the ActiveGate with the ID of 876651882.
The API token is passed in the Authorization header.
Curl
curl -L -X GET 'https://myManaged.cluster.com/api/cluster/v2/activeGates/876651882' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://myManaged.cluster.com/api/cluster/v2/activeGates/876651882
Response body
{
"id": "876651882",
"networkAddresses": [
"orange-13.easytravel.com",
"228.245.125.39"
],
"osType": "LINUX",
"autoUpdateStatus": "UPDATE_IN_PROGRESS",
"offlineSince": null,
"version": "1.198.0.20200630-163221",
"type": "ENVIRONMENT",
"hostname": "orange-13.easytravel.com",
"mainEnvironment": null,
"environments": [
"mySampleEnv"
],
"networkZone": "easytravel.europe.austria.05"
}
Response code
200