umon

Documentation

Index

• type DescribeResourceMetricRequest
• type DescribeResourceMetricResponse
• type GetMetricRequest
• type GetMetricResponse
• type MetricInfo
• type MetricItem
• type UMonClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *UMonClient
  • func (c *UMonClient) DescribeResourceMetric(req *DescribeResourceMetricRequest) (*DescribeResourceMetricResponse, error)
  • func (c *UMonClient) GetMetric(req *GetMetricRequest) (*GetMetricResponse, error)
  • func (c *UMonClient) NewDescribeResourceMetricRequest() *DescribeResourceMetricRequest
  • func (c *UMonClient) NewGetMetricRequest() *GetMetricRequest

Types

type DescribeResourceMetricRequest

type DescribeResourceMetricRequest struct {
	request.CommonBase

	// 资源类型
	ResourceType *string `required:"true"`
}

DescribeResourceMetricRequest is request schema for DescribeResourceMetric action

type DescribeResourceMetricResponse

type DescribeResourceMetricResponse struct {
	response.CommonBase

	// 指标信息集合
	DataSet []MetricInfo
}

DescribeResourceMetricResponse is response schema for DescribeResourceMetric action

type GetMetricRequest

type GetMetricRequest struct {
	request.CommonBase

	// 可用区。参见 [可用区列表](../summary/regionlist.html)
	Zone *string `required:"false"`

	// 资源类型
	ResourceType *string `required:"true"`

	// 指标名称（不同ResourceType对应不同的MetricName）
	MetricName []string `required:"true"`

	// 资源Id（目前除sharebandwidth可以不传入ResourceId外，其他资源必须传入，sharebandwidth不传入会默认使用获取到的第一个资源Id）
	ResourceId *string `required:"false"`

	// 拉取最近多少秒的监控数据，默认1小时，即3600；最大1个月
	TimeRange *int `required:"false"`

	// 起始时间unixtimestamp，若传入TimeRange，此项忽略
	BeginTime *int `required:"false"`

	// 结束时间unixtimestamp，若传入TimeRange，此项忽略；若只传入BeginTime，此项默认为当前时间
	EndTime *int `required:"false"`
}

GetMetricRequest is request schema for GetMetric action

type GetMetricResponse

type GetMetricResponse struct {
	response.CommonBase

	DataSets map[string][]MetricItem
}

GetMetricResponse is response schema for GetMetric action

type MetricInfo

type MetricInfo struct {

	// 指标名称
	MetricName string

	// 单位
	Unit string

	// 仅限内部使用
	ConversionFactor int

	// 数据类型
	Type string

	// 指标组名称，相同指标组前端可合并一张图显示
	MetricGroup string

	// 是否支持告警
	SupportAlarm string

	// 告警设置范围
	AlarmRange interface{} // Backend Bug: backend use dynamic type, object or string

	// 仅限内部使用
	Frequency int

	// 比较参数，可选GE,LE
	CompareOption []string
}

MetricInfo - GetMetricInfo-监控项信息

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type MetricItem

type MetricItem struct {
	Value interface{}

	Timestamp int
}

MetricItem - GetMetricInfo-监控项信息

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type UMonClient

type UMonClient struct {
	// contains filtered or unexported fields
}

UMonClient is the client of UMon

func NewClient

func NewClient(config *ucloud.Config, credential *auth.Credential) *UMonClient

NewClient will return a instance of UMonClient

func (*UMonClient) DescribeResourceMetric

func (c *UMonClient) DescribeResourceMetric(req *DescribeResourceMetricRequest) (*DescribeResourceMetricResponse, error)

DescribeResourceMetric - 获取资源支持监控指标信息

func (*UMonClient) GetMetric

func (c *UMonClient) GetMetric(req *GetMetricRequest) (*GetMetricResponse, error)

GetMetric - 获取监控数据

func (*UMonClient) NewDescribeResourceMetricRequest

func (c *UMonClient) NewDescribeResourceMetricRequest() *DescribeResourceMetricRequest

NewDescribeResourceMetricRequest will create request of DescribeResourceMetric action.

func (*UMonClient) NewGetMetricRequest

func (c *UMonClient) NewGetMetricRequest() *GetMetricRequest

NewGetMetricRequest will create request of GetMetric action.