File: property.go

package info (click to toggle)
golang-github-akamai-akamaiopen-edgegrid-golang 1.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 1,408 kB
  • sloc: sh: 532; makefile: 3
file content (213 lines) | stat: -rw-r--r-- 5,350 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
package reportsgtm

import (
	"github.com/akamai/AkamaiOPEN-edgegrid-golang/client-v1"
	"github.com/akamai/AkamaiOPEN-edgegrid-golang/configgtm-v1_3"

	"fmt"
)

//
// Support gtm reports thru Edgegrid
// Based on 1.0 Schema
//

// Property Traffic Report Structs
type PropertyTMeta struct {
	Uri      string `json:uri"`
	Domain   string `json:"domain"`
	Interval string `json:"interval,omitempty"`
	Property string `json:"property"`
	Start    string `json:"start"`
	End      string `json:"end"`
}

type PropertyDRow struct {
	Nickname          string `json:"nickname"`
	DatacenterId      int    `json:"datacenterId"`
	TrafficTargetName string `json:"trafficTargetName"`
	Requests          int64  `json:"requests"`
	Status            string `json:"status"`
}

type PropertyTData struct {
	Timestamp   string          `json:"timestamp"`
	Datacenters []*PropertyDRow `json:"datacenters"`
}

// The Property Traffic Response structure returned by the Reports API
type PropertyTrafficResponse struct {
	Metadata    *PropertyTMeta    `json:"metadata"`
	DataRows    []*PropertyTData  `json:"dataRows"`
	DataSummary interface{}       `json:"dataSummary"`
	Links       []*configgtm.Link `json:"links"`
}

//
// IP Status By Property Structs
//

// IP Availability Status Response structure returned by the Reports API.
type IPStatusPerProperty struct {
	Metadata    *IpStatPerPropMeta   `json:"metadata"`
	DataRows    []*IpStatPerPropData `json:"dataRows"`
	DataSummary interface{}          `json:"dataSummary"`
	Links       []*configgtm.Link    `json:"links"`
}

type IpStatPerPropMeta struct {
	Uri          string `json:uri"`
	Domain       string `json:"domain"`
	Property     string `json:"property"`
	Start        string `json:"start"`
	End          string `json:"end"`
	MostRecent   bool   `json:"mostRecent"`
	Ip           string `json:"ip"`
	DatacenterId int    `json:"datacenterId"`
}

type IpStatPerPropData struct {
	Timestamp   string               `json:"timestamp"`
	CutOff      float64              `json:"cutOff"`
	Datacenters []*IpStatPerPropDRow `json:"datacenters"`
}

type IpStatPerPropDRow struct {
	Nickname          string      `json:"nickname"`
	DatacenterId      int         `json:"datacenterId"`
	TrafficTargetName string      `json:"trafficTargetName"`
	IPs               []*IpStatIp `json:"IPs"`
}

type IpStatIp struct {
	Ip        string  `json:"ip"`
	HandedOut bool    `json:"handedOut"`
	Score     float32 `json:"score"`
	Alive     bool    `json:"alive"`
}

// GetIpStatusPerProperty retrieves current IP Availability Status for specified property in the given domainname.
func GetIpStatusPerProperty(domainName string, propertyName string, optArgs map[string]string) (*IPStatusPerProperty, error) {
	stat := &IPStatusPerProperty{}
	hostURL := fmt.Sprintf("/gtm-api/v1/reports/ip-availability/domains/%s/properties/%s", domainName, propertyName)

	req, err := client.NewRequest(
		Config,
		"GET",
		hostURL,
		nil,
	)
	if err != nil {
		return nil, err
	}

	// Look for and process optional query params
	q := req.URL.Query()
	for k, v := range optArgs {
		switch k {
		case "start":
			fallthrough
		case "end":
			fallthrough
		case "ip":
			fallthrough
		case "mostRecent":
			fallthrough
		case "datacenterId":
			q.Add(k, v)
		}
	}
	if optArgs != nil {
		req.URL.RawQuery = q.Encode()
	}

	// time stamps require urlencoded content header
	setEncodedHeader(req)

	// print/log the request if warranted
	printHttpRequest(req, true)

	res, err := client.Do(Config, req)
	if err != nil {
		return nil, err
	}

	// print/log the response if warranted
	printHttpResponse(res, true)

	if client.IsError(res) && res.StatusCode != 404 {
		return nil, client.NewAPIError(res)
	} else if res.StatusCode == 404 {
		cErr := configgtm.CommonError{}
		cErr.SetItem("entityName", "Property")
		cErr.SetItem("name", propertyName)
		return nil, cErr
	} else {
		err = client.BodyJSON(res, stat)
		if err != nil {
			return nil, err
		}

		return stat, nil
	}
}

// GetTrafficPerProperty retrieves report traffic for the specified property in the specified domain.
func GetTrafficPerProperty(domainName string, propertyName string, optArgs map[string]string) (*PropertyTrafficResponse, error) {
	stat := &PropertyTrafficResponse{}
	hostURL := fmt.Sprintf("/gtm-api/v1/reports/traffic/domains/%s/properties/%s", domainName, propertyName)

	req, err := client.NewRequest(
		Config,
		"GET",
		hostURL,
		nil,
	)
	if err != nil {
		return nil, err
	}

	// Look for and process optional query params
	q := req.URL.Query()
	for k, v := range optArgs {
		switch k {
		case "start":
			fallthrough
		case "end":
			q.Add(k, v)
		}
	}
	if optArgs != nil {
		req.URL.RawQuery = q.Encode()
	}

	// time stamps require urlencoded content header
	setEncodedHeader(req)

	// print/log the request if warranted
	printHttpRequest(req, true)

	res, err := client.Do(Config, req)
	if err != nil {
		return nil, err
	}

	// print/log the response if warranted
	printHttpResponse(res, true)

	if client.IsError(res) && res.StatusCode != 404 {
		return nil, client.NewAPIError(res)
	} else if res.StatusCode == 404 {
		cErr := configgtm.CommonError{}
		cErr.SetItem("entityName", "Property")
		cErr.SetItem("name", propertyName)
		return nil, cErr
	} else {
		err = client.BodyJSON(res, stat)
		if err != nil {
			return nil, err
		}

		return stat, nil
	}
}