Lists the available set of billing regions.
A request to retrieve a list of billing regions is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.transactcdn.com/v2/reporting/billing/regions |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters for each billing region returned by this endpoint:
Name | Data Type | Description |
---|---|---|
Code |
String |
Identifies the abbreviation associated with the billing region. |
Description |
String |
Provides a description for the billing region. |
Id |
Integer |
Defines the ID associated with the billing region. |
Name |
String |
Provides the name of the billing region. |
Status |
Integer |
Provides status information for the billing region. Valid return values are:
|
EdgeNodes |
Array |
This response parameter contains a list of POPs associated with the current billing region. |
EdgeNodeId |
Integer |
EdgeNodes array Identifies an edge node (POP) by its system-defined ID. |
Code |
String |
EdgeNodes array Identifies an edge node by its three letter abbreviation. |
Continent |
String |
EdgeNodes array Indicates the continent on which the edge node is located. |
City |
String |
EdgeNodes array Indicates the city where the edge node is located. |
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is shown below.
GET https://api.transactcdn.com/v2/reporting/billing/regions HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Content-Type: application/json
Host:api.transactcdn.com
A sample JSON response is shown below.
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Date: Thu, 15 Apr 2021 12:00:00 GMT
Content-Length: 45427
[{ "Code" : "GL", "Description" : "Global", "Id" : -1, "Name" : "Global", "Status" : 1, "EdgeNodes" : [{ "EdgeNodeId" : 4, "Code" : "BUY", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 5, "Code" : "BUZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 6, "Code" : "CPZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 7, "Code" : "ISL", "Continent" : "North America", "City" : "Los Angeles (CSTG)" }, { "EdgeNodeId" : 8, "Code" : "LAZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 9, "Code" : "AMZ", "Continent" : "Europe", "City" : "Amsterdam" }, { "EdgeNodeId" : 10, "Code" : "AMY", "Continent" : "Europe", "City" : "Amsterdam" }, { "EdgeNodeId" : 11, "Code" : "MAZ", "Continent" : "Europe", "City" : "Madrid" }, { "EdgeNodeId" : 12, "Code" : "LHZ", "Continent" : "Europe", "City" : "London" }, { "EdgeNodeId" : 13, "Code" : "ARZ", "Continent" : "Europe", "City" : "Stockholm" }, { "EdgeNodeId" : 14, "Code" : "ORZ", "Continent" : "Europe", "City" : "Paris" }, { "EdgeNodeId" : 15, "Code" : "VIZ", "Continent" : "Europe", "City" : "Vienna" }, { "EdgeNodeId" : 16, "Code" : "MIZ", "Continent" : "North America", "City" : "Miami" }, { "EdgeNodeId" : 17, "Code" : "ATZ", "Continent" : "North America", "City" : "Atlanta" }, { "EdgeNodeId" : 18, "Code" : "FTZ", "Continent" : "North America", "City" : "Dallas" }, { "EdgeNodeId" : 19, "Code" : "DCZ", "Continent" : "North America", "City" : "Ashburn" }, { "EdgeNodeId" : 20, "Code" : "JFZ", "Continent" : "North America", "City" : "New York" }, { "EdgeNodeId" : 21, "Code" : "MDZ", "Continent" : "North America", "City" : "Chicago" }, { "EdgeNodeId" : 22, "Code" : "SEZ", "Continent" : "North America", "City" : "Seattle" }, { "EdgeNodeId" : 23, "Code" : "SJZ", "Continent" : "North America", "City" : "San Jose" }, { "EdgeNodeId" : 24, "Code" : "FCZ", "Continent" : "Europe", "City" : "Frankfurt" }, { "EdgeNodeId" : 25, "Code" : "SYZ", "Continent" : "Australia", "City" : "Sydney" }, { "EdgeNodeId" : 26, "Code" : "NRZ", "Continent" : "Asia", "City" : "Tokyo" }, { "EdgeNodeId" : 27, "Code" : "HHZ", "Continent" : "Asia", "City" : "Hong Kong" }, { "EdgeNodeId" : 28, "Code" : "SIZ", "Continent" : "Asia", "City" : "Singapore" }, { "EdgeNodeId" : 29, "Code" : "N\/A", "Continent" : "Other", "City" : "N\/A" }, { "EdgeNodeId" : 55, "Code" : "DFZ", "Continent" : "North America", "City" : "Dallas" }, { "EdgeNodeId" : 56, "Code" : "EWZ", "Continent" : "North America", "City" : "New York" }, { "EdgeNodeId" : 80, "Code" : "5726", "Continent" : "5726", "City" : "test" }, { "EdgeNodeId" : 81, "Code" : "65601", "Continent" : "65601", "City" : "updated" }, { "EdgeNodeId" : 82, "Code" : "1951", "Continent" : "1951", "City" : "test" }, { "EdgeNodeId" : 83, "Code" : "VNZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 84, "Code" : "GIZ", "Continent" : "Latin America", "City" : "Rio de Janeiro" } ] }, { "Code" : "NE", "Description" : "North America & Europe", "Id" : 0, "Name" : "North America & Europe", "Status" : 1, "EdgeNodes" : [{ "EdgeNodeId" : 57, "Code" : "AMY", "Continent" : "Europe", "City" : "Amsterdam" }, { "EdgeNodeId" : 58, "Code" : "AMZ", "Continent" : "Europe", "City" : "Amsterdam" }, { "EdgeNodeId" : 59, "Code" : "ARZ", "Continent" : "Europe", "City" : "Stockholm" }, { "EdgeNodeId" : 60, "Code" : "ATZ", "Continent" : "North America", "City" : "Atlanta" }, { "EdgeNodeId" : 61, "Code" : "BUY", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 62, "Code" : "BUZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 63, "Code" : "CPZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 64, "Code" : "DCZ", "Continent" : "North America", "City" : "Ashburn" }, { "EdgeNodeId" : 65, "Code" : "FCZ", "Continent" : "Europe", "City" : "Frankfurt" }, { "EdgeNodeId" : 66, "Code" : "FTZ", "Continent" : "North America", "City" : "Dallas" }, { "EdgeNodeId" : 67, "Code" : "ISL", "Continent" : "North America", "City" : "Los Angeles (CSTG)" }, { "EdgeNodeId" : 68, "Code" : "JFZ", "Continent" : "North America", "City" : "New York" }, { "EdgeNodeId" : 69, "Code" : "LAZ", "Continent" : "North America", "City" : "Los Angeles" }, { "EdgeNodeId" : 70, "Code" : "LHZ", "Continent" : "Europe", "City" : "London" }, { "EdgeNodeId" : 71, "Code" : "MAZ", "Continent" : "Europe", "City" : "Madrid" }, { "EdgeNodeId" : 72, "Code" : "MDZ", "Continent" : "North America", "City" : "Chicago" }, { "EdgeNodeId" : 73, "Code" : "MIZ", "Continent" : "North America", "City" : "Miami" }, { "EdgeNodeId" : 74, "Code" : "ORZ", "Continent" : "Europe", "City" : "Paris" }, { "EdgeNodeId" : 75, "Code" : "SEZ", "Continent" : "North America", "City" : "Seattle" }, { "EdgeNodeId" : 76, "Code" : "SJZ", "Continent" : "North America", "City" : "San Jose" }, { "EdgeNodeId" : 77, "Code" : "VIZ", "Continent" : "Europe", "City" : "Vienna" }, { "EdgeNodeId" : 78, "Code" : "EWZ", "Continent" : "North America", "City" : "New York" }, { "EdgeNodeId" : 79, "Code" : "DFZ", "Continent" : "North America", "City" : "Dallas" } ] }, { "Code" : "AP", "Description" : "Asia & South America", "Id" : 1, "Name" : "Asia & South America", "Status" : 1, "EdgeNodes" : [{ "EdgeNodeId" : 85, "Code" : "HHZ", "Continent" : "Asia", "City" : "Hong Kong" }, { "EdgeNodeId" : 86, "Code" : "NRZ", "Continent" : "Asia", "City" : "Tokyo" }, { "EdgeNodeId" : 87, "Code" : "SIZ", "Continent" : "Asia", "City" : "Singapore" }, { "EdgeNodeId" : 88, "Code" : "SYZ", "Continent" : "Australia", "City" : "Sydney" }, { "EdgeNodeId" : 89, "Code" : "GIZ", "Continent" : "Latin America", "City" : "Rio de Janeiro" } ] } ]