Monitoring zones

A monitoring zone is a location that Rackspace Monitoring collects data from. Examples of monitoring zones are “US West”, “DFW1” or “ORD1”. It is an abstraction for a general location from which data is collected.

An endpoint, also known as a collector, collects data from the monitoring zone. The endpoint is mapped directly to an individual computer or a virtual machine. A monitoring zone contains many endpoints, all of which will be within the IP address range listed in the response. The opposite is not true, however, as there may be unallocated IP addresses or unrelated machines within that IP address range.

A check references a list of monitoring zones it should be run from.

Attributes

Name

Description

Validation

country_code

Country Code

  • String longer than 2 characters

label

Label

  • String

  • Non-empty string

source_ips

Source IP list

  • Array [String]

Use the following monitoring zones API operations to get information about monitoring zones and to run traceroutes.

For Private Network Monitoring, API operations are included to create, update, and delete private monitoring zones.

Note

Users cannot create, update, or delete monitoring zones, unless the monitoring zone is Private Network Monitoring.

List monitoring zones

GET /monitoring_zones

Lists the monitoring zones for the Rackspace Cloud Monitoring account.

This operation can be paginated. For information, see Paginated collections.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Request completed.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the haeder parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Note

This operation does not accept a request body.

Response

Example List monitoring zones: JSON response

{
    "values": [
        {
            "id": "mzAAAAA",
            "label": "US South (Atlanta) - 5",
            "country_code": "US",
            "source_ips": [
                "1.2.0.0/24"
            ]
        }
    ],
    "metadata": {
        "count": 1,
        "limit": 50,
        "marker": null,
        "next_marker": null,
        "next_href": null
    }
}

Get monitoring zone by ID

GET /monitoring_zones/{monitoringZoneId}

Returns information about the specified monitoring zone.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Request completed.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the header parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Note

This operation does not accept a request body.

Response

Example Get monitoring zone by ID: JSON response

{
    "id": "mzAAAAA",
    "label": "US South (Atlanta) - 5",
    "country_code": "US",
    "source_ips": [
        "1.2.0.0/24"
    ]
}

Perform a traceroute from a monitoring zone

POST /monitoring_zones/{monitoringZoneId}/traceroute

This API operation lets you run a traceroute from a monitoring zone to a Hostname or IP address. Like all Cloud Monitoring features, the Traceroute API is fully dual stack, supporting both IPv4 and IPv6. The Traceroute API can be used to debug networking issues between the Cloud Monitoring collectors and your infrastructure.

Note

Hop numbers can repeat, which indicates a split in the route.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

200

OK

Request completed.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the header parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Example Traceroute: JSON request

{
    "target": "google.com",
    "target_resolver": "IPv4"
}

Response

Example Traceroute: JSON response

{
    "result": [
        {
            "number": 1,
            "rtts": [
                3.025,
                3.116,
                3.189
            ],
            "ip": "50.57.208.106"
        },
        {
            "number": 2,
            "rtts": [
                0.675,
                0.943,
                1.083
            ],
            "ip": "50.56.6.34"
        },
        {
            "number": 3,
            "rtts": [
                0.558,
                0.824
            ],
            "ip": "50.56.6.16"
        },
        {
            "number": 3,
            "rtts": [
                0.606
            ],
            "ip": "50.56.6.18"
        },
        {
            "number": 4,
            "rtts": [
                0.239,
                0.252,
                0.247
            ],
            "ip": "184.106.126.139"
        },
        {
            "number": 5,
            "rtts": [
                3.418,
                3.444,
                3.453
            ],
            "ip": "69.31.110.241"
        },
        {
            "number": 6,
            "rtts": [
                1.219,
                1.231
            ],
            "ip": "69.31.110.249"
        },
        {
            "number": 6,
            "rtts": [
                1.3
            ],
            "ip": "69.31.110.253"
        },
        {
            "number": 7,
            "rtts": [
                2.463,
                2.224,
                2.196
            ],
            "ip": "206.223.119.21"
        },
        {
            "number": 8,
            "rtts": [
                1.831,
                2.041,
                1.814
            ],
            "ip": "209.85.254.130"
        },
        {
            "number": 9,
            "rtts": [
                2.558,
                1.977,
                3.105
            ],
            "ip": "72.14.237.133"
        },
        {
            "number": 10,
            "rtts": [
                51.028
            ],
            "ip": "216.239.46.214"
        },
        {
            "number": 10,
            "rtts": [
                29.526
            ],
            "ip": "216.239.46.216"
        },
        {
            "number": 10,
            "rtts": [
                48.987
            ],
            "ip": "216.239.46.214"
        },
        {
            "number": 11,
            "rtts": [
                105.6
            ],
            "ip": "216.239.46.219"
        },
        {
            "number": 11,
            "rtts": [
                128.521
            ],
            "ip": "216.239.43.5"
        },
        {
            "number": 11,
            "rtts": [
                105.548
            ],
            "ip": "216.239.46.219"
        },
        {
            "number": 12,
            "rtts": [
                109.492
            ],
            "ip": "72.14.235.175"
        },
        {
            "number": 12,
            "rtts": [
                106.523
            ],
            "ip": "72.14.235.173"
        },
        {
            "number": 12,
            "rtts": [
                105.952
            ],
            "ip": "72.14.235.175"
        },
        {
            "number": 13,
            "rtts": [
                106.482
            ],
            "ip": "216.239.43.233"
        },
        {
            "number": 13,
            "rtts": [
                106.92,
                106.681
            ],
            "ip": "209.85.253.20"
        },
        {
            "number": 14,
            "rtts": [
                129.616
            ],
            "ip": "72.14.236.191"
        },
        {
            "number": 14,
            "rtts": [
                106.329
            ],
            "ip": "209.85.252.83"
        },
        {
            "number": 14,
            "rtts": [
                106.253
            ],
            "ip": "216.239.49.45"
        },
        {
            "number": 15,
            "rtts": [],
            "ip": "*"
        },
        {
            "number": 16,
            "rtts": [
                106.101,
                106.075,
                106.48
            ],
            "ip": "173.194.78.139"
        }
    ]
}

Create a private monitoring zone

POST /monitoring_zones/

Create a new private monitoring zone.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

201

OK

The ‘Location’ header contains a link to the newly created entity.

400

Bad request

The system received an invalid value in a request.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the header parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Example Create a private monitoring zone: JSON request

The request body requires only a label field of type string.

{
    "label": "Zone A Information"
}

Response

This operation does not return a response body.

Update a private monitor zone by ID

PUT /monitoring_zones/{monitoringZoneId}

Updates the private monitoring zone specified by monitoringZoneId. You can make partial updates to a private monitoring zone. When you submit the update request, only specify the parameters that you want to update.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

204

OK

The server has fulfilled the request but does not need to return an entity- body.

400

Bad request

The system received an invalid value in a request.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

404

Not Found

The URL, entity, or account requested is not found in the system.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the header parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Example Update a private monitoring zone: JSON request

{
    "label": "Zone A Updated Information"
}

Response

This operation does not return a response body.

Delete a private monitoring zone by ID

DELETE monitoring_zones/{monitoringZoneId}

Deletes a specified private monitoring zone from your account. Also deletes any checks and alarms defined for that monitoring zone.

The following table shows the possible response codes for this operation:

Response Code

Name

Description

204

OK

The server has fulfilled the request. Does not return a response body.

401

Unauthorized

The system received a request from a user that is not authenticated.

403

Forbidden

The system received a request that the user is not authorized to make.

404

Not Found

The URL, entity, or account requested is not found in the system.

500

Internal Server Error

An unexpected condition was encountered.

503

Service Unavailable

The system is experiencing heavy load or another system failure.

Request

The following table shows the header parameters for the request:

Name

Type

Description

X-Auth-Token

String (Required)

A valid authentication token with administrative access. For details, see Get your credentials

Note

This operation does not accept a request body.

Response

This operation does not return a response body.