[CES] Reimplement Alarm Rules v1 API

acceptance/openstack/ces/v1/alarms_test.go

@@ -0,0 +1,61 @@
+package v1
+
+import (
+	"testing"
+
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/clients"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/ces/v1/alarms"
+	th "github.com/opentelekomcloud/gophertelekomcloud/testhelper"
+)
+
+func TestAlarms(t *testing.T) {
+	client, err := clients.NewCesV1Client()
+	th.AssertNoErr(t, err)
+
+	alarmsRes, err := alarms.ListAlarms(client, alarms.ListAlarmsRequest{
+		Limit: 10,
+		Order: "desc",
+	})
+
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, alarmsRes.MetaData.Count <= 10, true)
+
+	f := false
+	newAlarm, err := alarms.CreateAlarm(client, alarms.CreateAlarmRequest{
+		AlarmName: "alarm-acc-test",
+		Metric: alarms.MetricForAlarm{
+			Namespace:  "SYS.VPC",
+			MetricName: "upstream_bandwidth",
+			Dimensions: []alarms.MetricsDimension{
+				{
+					Name:  "bandwidth_id",
+					Value: "026c495c-fake-test-8b11-a113ba530d11",
+				},
+			},
+		},
+		Condition: alarms.Condition{
+			ComparisonOperator: ">=",
+			Count:              3,
+			Filter:             "average",
+			Period:             300,
+			Value:              4000000,
+		},
+		AlarmEnabled:       &f,
+		AlarmActionEnabled: &f,
+	})
+	th.AssertNoErr(t, err)
+
+	t.Cleanup(func() {
+		err = alarms.DeleteAlarm(client, newAlarm)
+		th.AssertNoErr(t, err)
+	})
+
+	err = alarms.UpdateAlarmAction(client, newAlarm, alarms.ModifyAlarmActionRequest{
+		AlarmEnabled: true,
+	})
+	th.AssertNoErr(t, err)
+
+	showAlarm, err := alarms.ShowAlarm(client, newAlarm)
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, showAlarm[0].AlarmEnabled, true)
+}

openstack/ces/v1/alarms/requests.go

@@ -0,0 +1,138 @@
+package alarms
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+)
+
+type ListAlarmsRequest struct {
+	// The value ranges from 1 to 100, and is 100 by default.
+	// This parameter is used to limit the number of query results.
+	Limit int `q:"limit"`
+	// Specifies the result sorting method, which is sorted by timestamp.
+	// The default value is desc.
+	// asc: The query results are displayed in the ascending order.
+	// desc: The query results are displayed in the descending order.
+	Order string `q:"order"`
+	// Specifies the first queried alarm to be displayed on a page.
+	Start string `q:"start"`
+}
+
+func ListAlarms(client *golangsdk.ServiceClient, opts ListAlarmsRequest) (*ListAlarmsResponse, error) {
+	url := alarmsURL(client)
+	query, err := golangsdk.BuildQueryString(opts)
+	if err != nil {
+		return nil, err
+	}
+
+	raw := golangsdk.Result{}
+	url += query.String()
+
+	_, err = client.Get(url, &raw.Body, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	var s ListAlarmsResponse
+	err = raw.ExtractInto(&s)
+	return &s, err
+}
+
+// ------------------------------------------------------------------------------------------------
+
+func ShowAlarm(client *golangsdk.ServiceClient, id string) ([]MetricAlarms, error) {
+	raw := golangsdk.Result{}
+	_, err := client.Get(alarmIdURL(client, id), &raw.Body, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	var res []MetricAlarms
+	err = raw.ExtractIntoSlicePtr(&res, "metric_alarms")
+	return res, err
+}
+
+// ------------------------------------------------------------------------------------------------
+
+type ModifyAlarmActionRequest struct {
+	// Specifies whether the alarm rule is enabled.
+	AlarmEnabled bool `json:"alarm_enabled"`
+}
+
+func UpdateAlarmAction(client *golangsdk.ServiceClient, id string, req ModifyAlarmActionRequest) (err error) {
+	reqBody, err := golangsdk.BuildRequestBody(req, "")
+	if err != nil {
+		return
+	}
+
+	_, err = client.Put(alarmActionURL(client, id), reqBody, nil, &golangsdk.RequestOpts{
+		OkCodes: []int{204},
+	})
+	return
+}
+
+// ------------------------------------------------------------------------------------------------
+
+func DeleteAlarm(client *golangsdk.ServiceClient, id string) (err error) {
+	_, err = client.Delete(alarmIdURL(client, id), &golangsdk.RequestOpts{
+		OkCodes: []int{204},
+	})
+	return
+}
+
+// ------------------------------------------------------------------------------------------------
+
+type CreateAlarmRequest struct {
+	// Specifies the alarm rule name.
+	// Enter 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
+	AlarmName string `json:"alarm_name"`
+	// Provides supplementary information about the alarm rule. Enter 0 to 256 characters.
+	AlarmDescription string `json:"alarm_description,omitempty"`
+	// Specifies the alarm metric.
+	Metric MetricForAlarm `json:"metric"`
+	// Specifies the alarm triggering condition.
+	Condition Condition `json:"condition"`
+	// Specifies whether to enable the alarm.
+	AlarmEnabled *bool `json:"alarm_enabled,omitempty"`
+	// Specifies whether to enable the action to be triggered by an alarm. The default value is true.
+	AlarmActionEnabled *bool `json:"alarm_action_enabled,omitempty"`
+	// Specifies the alarm severity. Possible values are 1, 2 (default), 3 and 4,
+	// indicating critical, major, minor, and informational, respectively.
+	AlarmLevel int `json:"alarm_level,omitempty"`
+	// Specifies the action to be triggered by an alarm.
+	AlarmActions []AlarmActions `json:"alarm_actions,omitempty"`
+	// Specifies the action to be triggered after the alarm is cleared.
+	OkActions []AlarmActions `json:"ok_actions,omitempty"`
+}
+
+type MetricForAlarm struct {
+	// Specifies the namespace of a service.
+	// The value must be in the service.item format and can contain 3 to 32 characters.
+	// service and item each must start with a letter and contain only letters, digits, and underscores (_).
+	Namespace string `json:"namespace"`
+	// Specifies the metric name.
+	// Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.
+	MetricName string `json:"metric_name"`
+	// Specifies the list of metric dimensions.
+	Dimensions []MetricsDimension `json:"dimensions,omitempty"`
+	// Specifies the resource group ID selected during the alarm rule creation.
+	ResourceGroupId string `json:"resource_group_id,omitempty"`
+}
+
+func CreateAlarm(client *golangsdk.ServiceClient, opts CreateAlarmRequest) (string, error) {
+	reqBody, err := golangsdk.BuildRequestBody(opts, "")
+	if err != nil {
+		return "", err
+	}
+
+	raw := golangsdk.Result{}
+	_, err = client.Post(alarmsURL(client), reqBody, &raw.Body, nil)
+	if err != nil {
+		return "", err
+	}
+
+	var s struct {
+		AlarmId string `json:"alarm_id"`
+	}
+	err = raw.ExtractInto(&s)
+	return s.AlarmId, err
+}

openstack/ces/v1/alarms/results.go

@@ -0,0 +1,88 @@
+package alarms
+
+type ListAlarmsResponse struct {
+	MetricAlarms []MetricAlarms `json:"metric_alarms,omitempty"`
+	MetaData     MetaData       `json:"meta_data,omitempty"`
+}
+
+type MetaData struct {
+	Count  int    `json:"count"`
+	Total  int    `json:"total"`
+	Marker string `json:"marker"`
+}
+
+type MetricAlarms struct {
+	// Specifies the alarm rule name.
+	AlarmName string `json:"alarm_name"`
+	// Provides supplementary information about the alarm rule.
+	AlarmDescription string `json:"alarm_description,omitempty"`
+	// Specifies the alarm metric.
+	Metric MetricForAlarm `json:"metric"`
+	// Specifies the alarm triggering condition.
+	Condition Condition `json:"condition"`
+	// Specifies whether to enable the alarm rule.
+	AlarmEnabled bool `json:"alarm_enabled,omitempty"`
+	// Specifies the alarm severity. Possible values are 1, 2, 3 and 4, indicating critical, major, minor, and informational, respectively.
+	AlarmLevel int `json:"alarm_level,omitempty"`
+	// Specifies whether to enable the action to be triggered by an alarm.
+	AlarmActionEnabled bool `json:"alarm_action_enabled,omitempty"`
+	// Specifies the action to be triggered by an alarm.
+	AlarmActions []AlarmActions `json:"alarm_actions,omitempty"`
+	//  Specifies the action to be triggered after the alarm is cleared.
+	OkActions []AlarmActions `json:"ok_actions,omitempty"`
+	// Specifies the alarm rule ID.
+	AlarmId string `json:"alarm_id"`
+	// Specifies when the alarm status changed. The value is a UNIX timestamp and the unit is ms.
+	UpdateTime int64 `json:"update_time"`
+	// Specifies the alarm status. The value can be:
+	//
+	// ok: The alarm status is normal.
+	// alarm: An alarm is generated.
+	// insufficient_data: The required data is insufficient.
+	AlarmState string `json:"alarm_state"`
+}
+
+type MetricsDimension struct {
+	// Specifies the dimension. For example, the ECS dimension is instance_id.
+	Name string `json:"name"`
+	// Specifies the dimension value, for example, an ECS ID.
+	Value string `json:"value"`
+}
+
+type Condition struct {
+	// Specifies the operator of alarm thresholds. Possible values are >, =, <, >=, and <=.
+	ComparisonOperator string `json:"comparison_operator"`
+	// Specifies the number of consecutive occurrence times that the alarm policy was met.
+	// The value ranges from 1 to 5.
+	Count int `json:"count"`
+	// Specifies the data rollup method. The following methods are supported:
+	//
+	// average: Cloud Eye calculates the average value of metric data within a rollup period.
+	// max: Cloud Eye calculates the maximum value of metric data within a rollup period.
+	// min: Cloud Eye calculates the minimum value of metric data within a rollup period.
+	// sum: Cloud Eye calculates the sum of metric data within a rollup period.
+	// variance: Cloud Eye calculates the variance value of metric data within a rollup period.
+	Filter string `json:"filter"`
+	// Specifies the interval (seconds) for checking whether the configured alarm rules are met.
+	Period int `json:"period"`
+	// Specifies the data unit. Enter up to 32 characters.
+	Unit string `json:"unit,omitempty"`
+	// Specifies the alarm threshold. The value ranges from 0 to Number. MAX_VALUE (1.7976931348623157e+108).
+	//
+	// For detailed thresholds, see the value range of each metric in the appendix.
+	// For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.
+	Value float64 `json:"value"`
+}
+
+type AlarmActions struct {
+	// Specifies the alarm notification type.
+	// notification: indicates that a notification will be sent.
+	// autoscaling: indicates that a scaling action will be triggered.
+	Type string `json:"type"`
+	// Specifies the list of objects to be notified if the alarm status changes.
+	// You can configure up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format:
+	// urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.
+	// If you set type to notification, you must specify notificationList.
+	// If you set type to autoscaling, you must set notificationList to [].
+	NotificationList []string `json:"notificationList"`
+}

openstack/ces/v1/alarms/urls.go

@@ -0,0 +1,22 @@
+package alarms
+
+import golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+
+const alarms = "alarms"
+
+// GET /V1.0/{project_id}/alarms
+// POST /V1.0/{project_id}/alarms
+func alarmsURL(c *golangsdk.ServiceClient) string {
+	return c.ServiceURL(alarms)
+}
+
+// GET /V1.0/{project_id}/alarms/{alarm_id}
+// DELETE /V1.0/{project_id}/alarms/{alarm_id}
+func alarmIdURL(c *golangsdk.ServiceClient, id string) string {
+	return c.ServiceURL(alarms, id)
+}
+
+// PUT /V1.0/{project_id}/alarms/{alarm_id}/action
+func alarmActionURL(c *golangsdk.ServiceClient, id string) string {
+	return c.ServiceURL(alarms, id, "action")
+}