3.1.5.23 networkControllerStatistics
The networkControllerStatistics resource provides a means to get usage and health information for a few resources:
Health for virtualNetworks, gateways, and loadBalancerMuxes.
Usage for publicIPAddresses, loadBalancer backend IPs and macPools.
It is invoked through the following URI.
-
https://<url>/networking/v1/monitoring/networkControllerStatistics
url: The address or name of the REST server of the Network Controller.
Note The server MAY support additional versions, besides v1 in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
GET |
Map one instance ID to resource ID. |
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
resourceRef |
Read-only |
Specified in Common JSON Elements, section 2.2.2. Must be /monitoring/networkControllerStatistics. |
|
instanceId |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
Properties.provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
Properties.healthStatistics |
Read-only |
Array of healthStatisticsItem, properties table follows. |
|
Properties.usageStatistics |
Read-only |
Array of usageStatisticsItem, properties table follows. |
|
counters |
Read-only Optional |
Array of ResourceCounter structures, section 3.1.1.1. This property is supported with URI version v2 or later. |
healthStatisticsItem
|
Element name |
Type |
Description |
|---|---|---|
|
resourceType |
Read-only |
Can be VirtualNetwork, Gateway or LoadBalancerMux These correspond to the top-level resources virtualNetworks, gateways, or loadBalancerMuxes. |
|
totalResourceCount |
Read-only |
Total count of REST resources of the type of resource specified by resourceType. |
|
healthyResourceCount |
Read-only |
Count of such resources in healthy state. |
|
errorResourceCount |
Read-only |
Count of such resources in an error state. |
|
warningResourceCount |
Read-only |
Count of such resources in a warning state. |
|
healthUnknownCount |
Read-only |
Count of such resources for which the health cannot be assessed. |
usageStatisticsItem
|
Element name |
Type |
Description |
|---|---|---|
|
resourceType |
Read-only |
Can be PublicIPUtilization, BackendIPUtilization or MacPoolUtilization corresponding to publicIPAddresses resource, IPs in backendAddressPools, or macPools resource. |
|
totalResourceCount |
Read-only |
Total count of REST resources of the type of resource specified by resourceType. |
|
inUseResourceCount |
Read-only |
Count of such resources that are in use. |