Documentation
¶
Overview ¶
Package cloudwatch include resources of ucloud cloudwatch product
See also
- API: https://docs.ucloud.cn/api/cloudwatch-api/index
- Product: https://www.ucloud.cn/site/product/cloudwatch.html
for detail.
Index ¶
- type AlertRecord
- type AlertRule
- type AlertStrategy
- type AlertStrategyId
- type AlertTemplate
- type BindAlertStrategyRequest
- type BindAlertStrategyResponse
- type CloudWatchClient
- func (c *CloudWatchClient) BindAlertStrategy(req *BindAlertStrategyRequest) (*BindAlertStrategyResponse, error)
- func (c *CloudWatchClient) CreateAlertStrategy(req *CreateAlertStrategyRequest) (*CreateAlertStrategyResponse, error)
- func (c *CloudWatchClient) CreateAlertStrategyTemplate(req *CreateAlertStrategyTemplateRequest) (*CreateAlertStrategyTemplateResponse, error)
- func (c *CloudWatchClient) DeleteAlertStrategyTemplate(req *DeleteAlertStrategyTemplateRequest) (*DeleteAlertStrategyTemplateResponse, error)
- func (c *CloudWatchClient) EnableAlertStrategy(req *EnableAlertStrategyRequest) (*EnableAlertStrategyResponse, error)
- func (c *CloudWatchClient) GetMetricDataAggregationMethod(req *GetMetricDataAggregationMethodRequest) (*GetMetricDataAggregationMethodResponse, error)
- func (c *CloudWatchClient) GetProductMetrics(req *GetProductMetricsRequest) (*GetProductMetricsResponse, error)
- func (c *CloudWatchClient) ListAlertRecord(req *ListAlertRecordRequest) (*ListAlertRecordResponse, error)
- func (c *CloudWatchClient) ListAlertStrategy(req *ListAlertStrategyRequest) (*ListAlertStrategyResponse, error)
- func (c *CloudWatchClient) ListAlertStrategyTemplate(req *ListAlertStrategyTemplateRequest) (*ListAlertStrategyTemplateResponse, error)
- func (c *CloudWatchClient) ListMonitorProduct(req *ListMonitorProductRequest) (*ListMonitorProductResponse, error)
- func (c *CloudWatchClient) ModifyAlertStrategyRemark(req *ModifyAlertStrategyRemarkRequest) (*ModifyAlertStrategyRemarkResponse, error)
- func (c *CloudWatchClient) NewBindAlertStrategyRequest() *BindAlertStrategyRequest
- func (c *CloudWatchClient) NewCreateAlertStrategyRequest() *CreateAlertStrategyRequest
- func (c *CloudWatchClient) NewCreateAlertStrategyTemplateRequest() *CreateAlertStrategyTemplateRequest
- func (c *CloudWatchClient) NewDeleteAlertStrategyTemplateRequest() *DeleteAlertStrategyTemplateRequest
- func (c *CloudWatchClient) NewEnableAlertStrategyRequest() *EnableAlertStrategyRequest
- func (c *CloudWatchClient) NewGetMetricDataAggregationMethodRequest() *GetMetricDataAggregationMethodRequest
- func (c *CloudWatchClient) NewGetProductMetricsRequest() *GetProductMetricsRequest
- func (c *CloudWatchClient) NewListAlertRecordRequest() *ListAlertRecordRequest
- func (c *CloudWatchClient) NewListAlertStrategyRequest() *ListAlertStrategyRequest
- func (c *CloudWatchClient) NewListAlertStrategyTemplateRequest() *ListAlertStrategyTemplateRequest
- func (c *CloudWatchClient) NewListMonitorProductRequest() *ListMonitorProductRequest
- func (c *CloudWatchClient) NewModifyAlertStrategyRemarkRequest() *ModifyAlertStrategyRemarkRequest
- func (c *CloudWatchClient) NewQueryMetricDataSetRequest() *QueryMetricDataSetRequest
- func (c *CloudWatchClient) NewQueryMetricDataSummaryRequest() *QueryMetricDataSummaryRequest
- func (c *CloudWatchClient) NewUnBindAlertStrategyRequest() *UnBindAlertStrategyRequest
- func (c *CloudWatchClient) NewUpdateAlertStrategyRequest() *UpdateAlertStrategyRequest
- func (c *CloudWatchClient) NewUpdateAlertStrategyTemplateRequest() *UpdateAlertStrategyTemplateRequest
- func (c *CloudWatchClient) QueryMetricDataSet(req *QueryMetricDataSetRequest) (*QueryMetricDataSetResponse, error)
- func (c *CloudWatchClient) QueryMetricDataSummary(req *QueryMetricDataSummaryRequest) (*QueryMetricDataSummaryResponse, error)
- func (c *CloudWatchClient) UnBindAlertStrategy(req *UnBindAlertStrategyRequest) (*UnBindAlertStrategyResponse, error)
- func (c *CloudWatchClient) UpdateAlertStrategy(req *UpdateAlertStrategyRequest) (*UpdateAlertStrategyResponse, error)
- func (c *CloudWatchClient) UpdateAlertStrategyTemplate(req *UpdateAlertStrategyTemplateRequest) (*UpdateAlertStrategyTemplateResponse, error)
- type ContentAttrItem
- type ConversionRule
- type CreateAlertStrategyParamRuleSet
- type CreateAlertStrategyRequest
- type CreateAlertStrategyResponse
- type CreateAlertStrategyTemplateParamRuleSet
- type CreateAlertStrategyTemplateRequest
- type CreateAlertStrategyTemplateResponse
- type DelAlertTemplate
- type DeleteAlertStrategyTemplateRequest
- type DeleteAlertStrategyTemplateResponse
- type EnableAlertStrategyRequest
- type EnableAlertStrategyResponse
- type GetMetricDataAggregationMethodRequest
- type GetMetricDataAggregationMethodResp
- type GetMetricDataAggregationMethodResponse
- type GetProductMetricsRequest
- type GetProductMetricsRespData
- type GetProductMetricsResponse
- type LabelAttrItem
- type ListAlertRecordParamFilter
- type ListAlertRecordRequest
- type ListAlertRecordResponse
- type ListAlertStrategyParamFilter
- type ListAlertStrategyRequest
- type ListAlertStrategyResponse
- type ListAlertStrategyTemplateParamFilter
- type ListAlertStrategyTemplateRequest
- type ListAlertStrategyTemplateResponse
- type ListAlertTemplate
- type ListMonitorProduct
- type ListMonitorProductRequest
- type ListMonitorProductResponse
- type Metirc
- type MetricDataAggregationMethod
- type MetricResult
- type MetricSample
- type MetricSingleSample
- type MetricUnit
- type MetricUnitConfig
- type ModifyAlertStrategyRemarkRequest
- type ModifyAlertStrategyRemarkResponse
- type Product
- type QueryMetricDataResp
- type QueryMetricDataRespItem
- type QueryMetricDataSetParamMetricInfos
- type QueryMetricDataSetParamMetricInfosTagList
- type QueryMetricDataSetRequest
- type QueryMetricDataSetResponse
- type QueryMetricDataSummaryRequest
- type QueryMetricDataSummaryRespData
- type QueryMetricDataSummaryResponse
- type ResourceExtendAttrItem
- type ResourceMonitorItem
- type ResourceSummary
- type TagEntry
- type TagListItem
- type UnBindAlertStrategyRequest
- type UnBindAlertStrategyResponse
- type UpdateAlertStrategyParamRuleSet
- type UpdateAlertStrategyRequest
- type UpdateAlertStrategyResponse
- type UpdateAlertStrategyTemplateParamRuleSet
- type UpdateAlertStrategyTemplateRequest
- type UpdateAlertStrategyTemplateResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlertRecord ¶
type AlertRecord struct {
// 产品相关的额外属性列表
ContentAttrList []ContentAttrItem
// 告警结束时间
EndAt int
// 告警等级
Level string
// 指标id
MetricID int
// 指标名称
MetricName string
// 产品类型名称
ProductName string
// 产品类型
ProductType int
// 项目ProjectID
ProjectID int
// 告警记录RecordID
RecordID int
// 可用区
Region string
// 资源id
ResourceID string
// 告警记录触发告警规则Id
RuleID int
// 告警屏蔽规则id(如果配置了屏蔽规则,并且满足条件)
ShieldRuleID int
// 告警触发时间
StartAt int
// 告警状态
Status string
// 告警记录触发告警策略Id
StrategyID int
// 告警记录触发告警策略名称
StrategyName string
// 告警点tag信息
Tag []string
// 比较符
ThresholdCompare int
// 告警阈值
ThresholdValue int
// 指标单位名称
UnitName string
// 告警当前值
Value int
}
AlertRecord - 告警记录模型
type AlertRule ¶
type AlertRule struct {
// 告警等级。枚举值:P0,P1,P2,P3
Level string
// 规则指标ID。参考该类型产品下返回的指标列表GetProductMetrics
MetricID int
// 指标名称
MetricName string
// 规则ID
RuleID int
// 发送间隔
SendInterval int
// 触发周期。枚举值:continuous连续 exponent 指数 single 不重复
SendPeriodType string
// 告警状态。枚举值:0-关闭 1-开启
Status int
// 阈值比较方式枚举值比较方式:1->=2-<=3->4-<5-==6-!=
ThresholdCompare int
// 触发阈值
ThresholdValue float64
// 触发次数
TriggerCount int
// 单位id
UnitID int
// 单位名称
UnitName string
}
AlertRule - 告警规则
type AlertStrategy ¶
type AlertStrategy struct {
// 告警策略Id
AlertStrategyID int
// 回调语言(cn,en)
CallbackLanguage string
// 回调地址
CallbackUrls []string
// 告警规则配置类型(基于模板配置、基于手工配置)
ConfigMode int
// 创建时间
CreatedAt int
// 创建人
CreatedBy string
// 告警策略名称
Name string
// 通知渠道('email', 'sms', 'webhook')
NotifyChannelDs []string
// 通知组id集合
NotifyGroupIDs []int
// 通知方式(通知组:group,通知人:user)
NotifyType string
// 通知人用户id集合
NotifyUserIDs []int
// 资源类型名称
ProductKey string
// 资源类型
ProductType int
// 告警策略备注
Remark string
// 告警规则集合
RuleSet []AlertRule
// 告警策略状态
Status int
// 模板Id
TemplateId int
// 更新时间
UpdatedAt int
// 更新人
UpdatedBy string
}
AlertStrategy - 告警策略模型
type AlertStrategyId ¶ added in v0.22.110
type AlertStrategyId struct {
// 告警策略id
AlertStrategyID int
}
AlertStrategyId - 告警策略id
type BindAlertStrategyRequest ¶
type BindAlertStrategyRequest struct {
request.CommonBase
// 告警策略id数组
AlertStrategyIDs []int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 资源数组
Resources []string `required:"true"`
}
BindAlertStrategyRequest is request schema for BindAlertStrategy action
type BindAlertStrategyResponse ¶
type BindAlertStrategyResponse struct {
response.CommonBase
}
BindAlertStrategyResponse is response schema for BindAlertStrategy action
type CloudWatchClient ¶
CloudWatchClient is the client of CloudWatch
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *CloudWatchClient
NewClient will return a instance of CloudWatchClient
func (*CloudWatchClient) BindAlertStrategy ¶
func (c *CloudWatchClient) BindAlertStrategy(req *BindAlertStrategyRequest) (*BindAlertStrategyResponse, error)
API: BindAlertStrategy
绑定告警策略
func (*CloudWatchClient) CreateAlertStrategy ¶ added in v0.22.110
func (c *CloudWatchClient) CreateAlertStrategy(req *CreateAlertStrategyRequest) (*CreateAlertStrategyResponse, error)
API: CreateAlertStrategy
创建告警策略
func (*CloudWatchClient) CreateAlertStrategyTemplate ¶
func (c *CloudWatchClient) CreateAlertStrategyTemplate(req *CreateAlertStrategyTemplateRequest) (*CreateAlertStrategyTemplateResponse, error)
API: CreateAlertStrategyTemplate
新建条件模板
func (*CloudWatchClient) DeleteAlertStrategyTemplate ¶
func (c *CloudWatchClient) DeleteAlertStrategyTemplate(req *DeleteAlertStrategyTemplateRequest) (*DeleteAlertStrategyTemplateResponse, error)
API: DeleteAlertStrategyTemplate
删除告警条件模板
func (*CloudWatchClient) EnableAlertStrategy ¶ added in v0.22.110
func (c *CloudWatchClient) EnableAlertStrategy(req *EnableAlertStrategyRequest) (*EnableAlertStrategyResponse, error)
API: EnableAlertStrategy
是否启用告警策略
func (*CloudWatchClient) GetMetricDataAggregationMethod ¶ added in v0.22.110
func (c *CloudWatchClient) GetMetricDataAggregationMethod(req *GetMetricDataAggregationMethodRequest) (*GetMetricDataAggregationMethodResponse, error)
API: GetMetricDataAggregationMethod
获取指标数据聚合方式
func (*CloudWatchClient) GetProductMetrics ¶
func (c *CloudWatchClient) GetProductMetrics(req *GetProductMetricsRequest) (*GetProductMetricsResponse, error)
API: GetProductMetrics
获取云产品关联的指标列表
func (*CloudWatchClient) ListAlertRecord ¶
func (c *CloudWatchClient) ListAlertRecord(req *ListAlertRecordRequest) (*ListAlertRecordResponse, error)
API: ListAlertRecord
获取时间段内的告警记录
func (*CloudWatchClient) ListAlertStrategy ¶
func (c *CloudWatchClient) ListAlertStrategy(req *ListAlertStrategyRequest) (*ListAlertStrategyResponse, error)
API: ListAlertStrategy
获取告警策略列表
func (*CloudWatchClient) ListAlertStrategyTemplate ¶ added in v0.22.110
func (c *CloudWatchClient) ListAlertStrategyTemplate(req *ListAlertStrategyTemplateRequest) (*ListAlertStrategyTemplateResponse, error)
API: ListAlertStrategyTemplate
条件模板列表
func (*CloudWatchClient) ListMonitorProduct ¶
func (c *CloudWatchClient) ListMonitorProduct(req *ListMonitorProductRequest) (*ListMonitorProductResponse, error)
API: ListMonitorProduct
获取监控对象类型列表
func (*CloudWatchClient) ModifyAlertStrategyRemark ¶ added in v0.22.110
func (c *CloudWatchClient) ModifyAlertStrategyRemark(req *ModifyAlertStrategyRemarkRequest) (*ModifyAlertStrategyRemarkResponse, error)
API: ModifyAlertStrategyRemark
修改告警策略备注
func (*CloudWatchClient) NewBindAlertStrategyRequest ¶
func (c *CloudWatchClient) NewBindAlertStrategyRequest() *BindAlertStrategyRequest
NewBindAlertStrategyRequest will create request of BindAlertStrategy action.
func (*CloudWatchClient) NewCreateAlertStrategyRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewCreateAlertStrategyRequest() *CreateAlertStrategyRequest
NewCreateAlertStrategyRequest will create request of CreateAlertStrategy action.
func (*CloudWatchClient) NewCreateAlertStrategyTemplateRequest ¶
func (c *CloudWatchClient) NewCreateAlertStrategyTemplateRequest() *CreateAlertStrategyTemplateRequest
NewCreateAlertStrategyTemplateRequest will create request of CreateAlertStrategyTemplate action.
func (*CloudWatchClient) NewDeleteAlertStrategyTemplateRequest ¶
func (c *CloudWatchClient) NewDeleteAlertStrategyTemplateRequest() *DeleteAlertStrategyTemplateRequest
NewDeleteAlertStrategyTemplateRequest will create request of DeleteAlertStrategyTemplate action.
func (*CloudWatchClient) NewEnableAlertStrategyRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewEnableAlertStrategyRequest() *EnableAlertStrategyRequest
NewEnableAlertStrategyRequest will create request of EnableAlertStrategy action.
func (*CloudWatchClient) NewGetMetricDataAggregationMethodRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewGetMetricDataAggregationMethodRequest() *GetMetricDataAggregationMethodRequest
NewGetMetricDataAggregationMethodRequest will create request of GetMetricDataAggregationMethod action.
func (*CloudWatchClient) NewGetProductMetricsRequest ¶
func (c *CloudWatchClient) NewGetProductMetricsRequest() *GetProductMetricsRequest
NewGetProductMetricsRequest will create request of GetProductMetrics action.
func (*CloudWatchClient) NewListAlertRecordRequest ¶
func (c *CloudWatchClient) NewListAlertRecordRequest() *ListAlertRecordRequest
NewListAlertRecordRequest will create request of ListAlertRecord action.
func (*CloudWatchClient) NewListAlertStrategyRequest ¶
func (c *CloudWatchClient) NewListAlertStrategyRequest() *ListAlertStrategyRequest
NewListAlertStrategyRequest will create request of ListAlertStrategy action.
func (*CloudWatchClient) NewListAlertStrategyTemplateRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewListAlertStrategyTemplateRequest() *ListAlertStrategyTemplateRequest
NewListAlertStrategyTemplateRequest will create request of ListAlertStrategyTemplate action.
func (*CloudWatchClient) NewListMonitorProductRequest ¶
func (c *CloudWatchClient) NewListMonitorProductRequest() *ListMonitorProductRequest
NewListMonitorProductRequest will create request of ListMonitorProduct action.
func (*CloudWatchClient) NewModifyAlertStrategyRemarkRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewModifyAlertStrategyRemarkRequest() *ModifyAlertStrategyRemarkRequest
NewModifyAlertStrategyRemarkRequest will create request of ModifyAlertStrategyRemark action.
func (*CloudWatchClient) NewQueryMetricDataSetRequest ¶
func (c *CloudWatchClient) NewQueryMetricDataSetRequest() *QueryMetricDataSetRequest
NewQueryMetricDataSetRequest will create request of QueryMetricDataSet action.
func (*CloudWatchClient) NewQueryMetricDataSummaryRequest ¶
func (c *CloudWatchClient) NewQueryMetricDataSummaryRequest() *QueryMetricDataSummaryRequest
NewQueryMetricDataSummaryRequest will create request of QueryMetricDataSummary action.
func (*CloudWatchClient) NewUnBindAlertStrategyRequest ¶
func (c *CloudWatchClient) NewUnBindAlertStrategyRequest() *UnBindAlertStrategyRequest
NewUnBindAlertStrategyRequest will create request of UnBindAlertStrategy action.
func (*CloudWatchClient) NewUpdateAlertStrategyRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewUpdateAlertStrategyRequest() *UpdateAlertStrategyRequest
NewUpdateAlertStrategyRequest will create request of UpdateAlertStrategy action.
func (*CloudWatchClient) NewUpdateAlertStrategyTemplateRequest ¶ added in v0.22.110
func (c *CloudWatchClient) NewUpdateAlertStrategyTemplateRequest() *UpdateAlertStrategyTemplateRequest
NewUpdateAlertStrategyTemplateRequest will create request of UpdateAlertStrategyTemplate action.
func (*CloudWatchClient) QueryMetricDataSet ¶
func (c *CloudWatchClient) QueryMetricDataSet(req *QueryMetricDataSetRequest) (*QueryMetricDataSetResponse, error)
API: QueryMetricDataSet
查询监控指标数据集
func (*CloudWatchClient) QueryMetricDataSummary ¶
func (c *CloudWatchClient) QueryMetricDataSummary(req *QueryMetricDataSummaryRequest) (*QueryMetricDataSummaryResponse, error)
API: QueryMetricDataSummary
获取资源看图属性列表
func (*CloudWatchClient) UnBindAlertStrategy ¶
func (c *CloudWatchClient) UnBindAlertStrategy(req *UnBindAlertStrategyRequest) (*UnBindAlertStrategyResponse, error)
API: UnBindAlertStrategy
解绑告警策略
func (*CloudWatchClient) UpdateAlertStrategy ¶ added in v0.22.110
func (c *CloudWatchClient) UpdateAlertStrategy(req *UpdateAlertStrategyRequest) (*UpdateAlertStrategyResponse, error)
API: UpdateAlertStrategy
更新告警策略
func (*CloudWatchClient) UpdateAlertStrategyTemplate ¶ added in v0.22.110
func (c *CloudWatchClient) UpdateAlertStrategyTemplate(req *UpdateAlertStrategyTemplateRequest) (*UpdateAlertStrategyTemplateResponse, error)
API: UpdateAlertStrategyTemplate
编辑条件模板
type ContentAttrItem ¶ added in v0.22.111
ContentAttrItem - 告警内容属性项
type ConversionRule ¶
ConversionRule - 指标单位转换规则
type CreateAlertStrategyParamRuleSet ¶ added in v0.22.110
type CreateAlertStrategyParamRuleSet struct {
// 告警等级。枚举值:P0,P1,P2,P3
Level *string `required:"false"`
// 规则指标ID。参考该类型产品下返回的指标列表GetProductMetrics
MetricID *int `required:"false"`
// 沉默周期(告警周期选择为连续时必填)
SendInterval *int `required:"false"`
// 触发周期。枚举值continuous - 连续exponent - 指数single - 不重复
SendPeriodType *string `required:"false"`
// 告警状态。枚举值0 - 关闭1 - 开启
Status *int `required:"false"`
// 阈值比较方式。 枚举值:1:>= 2:<= 3:> 4:< 5:== 6:!=
ThresholdCompare *int `required:"false"`
// 触发阈值
ThresholdValue *int `required:"false"`
// 触发次数
TriggerCount *int `required:"false"`
}
CreateAlertStrategyParamRuleSet is request schema for complex param
type CreateAlertStrategyRequest ¶ added in v0.22.110
type CreateAlertStrategyRequest struct {
request.CommonBase
// 当通知渠道=回调webhook时,需要设置回调语言。枚举值:cn - 中文en - 英文
CallbackLanguage *string `required:"false"`
// 回调URL地址
CallbackUrls []string `required:"false"`
// 条件设置方式1 - 手动配置 2 - 选择模版
ConfigMode *int `required:"true"`
// 告警策略名称。最大长度255个字符
Name *string `required:"true"`
// 通知渠道。枚举值:sms - 短信email - 邮件webhook - 回调
NotifyChannelDs []string `required:"false"`
// 通知人组id
NotifyGroupIDs []int `required:"false"`
// 通知模板id
NotifyTemplateId *string `required:"false"`
// 通知类型。枚举值: group - 通知组 user - 通知人
NotifyType *string `required:"false"`
// 通知人id
NotifyUserIDs []int `required:"false"`
// 绑定资源类型1 - 资源组 2 - 资源
ObjectType *int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 绑定资源组,对应绑定资源类型ObjectType=1
ResourceGroupIDs []int `required:"false"`
// 绑定资源,对应绑定资源类型ObjectType=2
Resources []string `required:"false"`
//
RuleSet []CreateAlertStrategyParamRuleSet `required:"false"`
// 模板id.对应ConfigMode=2时候需要填写
TemplateId *int `required:"false"`
}
CreateAlertStrategyRequest is request schema for CreateAlertStrategy action
type CreateAlertStrategyResponse ¶ added in v0.22.110
type CreateAlertStrategyResponse struct {
response.CommonBase
// 创建告警策略返回对象
Data AlertStrategyId
}
CreateAlertStrategyResponse is response schema for CreateAlertStrategy action
type CreateAlertStrategyTemplateParamRuleSet ¶
type CreateAlertStrategyTemplateParamRuleSet struct {
// 告警等级。枚举值:P0,P1,P2,P3
Level *string `required:"true"`
// 规则指标ID。参考该类型产品下返回的指标列表GetProductMetrics
MetricID *int `required:"true"`
// 沉默周期(告警周期选择为连续时必填)
SendInterval *int `required:"false"`
// 触发周期。枚举值:continuous连续 exponent 指数 single 不重复
SendPeriodType *string `required:"true"`
// 告警状态。枚举值:0-关闭 1-开启
Status *int `required:"true"`
// 阈值比较方式。枚举值: 1:>= 2:<= 3:> 4:< 5:== 6:!=
ThresholdCompare *int `required:"true"`
// 触发阈值
ThresholdValue *int `required:"true"`
// 触发次数
TriggerCount *int `required:"true"`
}
CreateAlertStrategyTemplateParamRuleSet is request schema for complex param
type CreateAlertStrategyTemplateRequest ¶
type CreateAlertStrategyTemplateRequest struct {
request.CommonBase
// 告警模板名称。最大长度64个字符
Name *string `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 备注
Remark *string `required:"false"`
//
RuleSet []CreateAlertStrategyTemplateParamRuleSet `required:"false"`
}
CreateAlertStrategyTemplateRequest is request schema for CreateAlertStrategyTemplate action
type CreateAlertStrategyTemplateResponse ¶
type CreateAlertStrategyTemplateResponse struct {
response.CommonBase
// 创建告警模板返回对象
Data AlertTemplate
}
CreateAlertStrategyTemplateResponse is response schema for CreateAlertStrategyTemplate action
type DelAlertTemplate ¶
type DelAlertTemplate struct {
// 模板ID
TemplateID []int
}
DelAlertTemplate - 删除告警模型返回对象
type DeleteAlertStrategyTemplateRequest ¶
type DeleteAlertStrategyTemplateRequest struct {
request.CommonBase
// 告警模板ID(支持批量删除)
TemplateID []int `required:"true"`
}
DeleteAlertStrategyTemplateRequest is request schema for DeleteAlertStrategyTemplate action
type DeleteAlertStrategyTemplateResponse ¶
type DeleteAlertStrategyTemplateResponse struct {
response.CommonBase
// 删除告警模板返回对象
Data DelAlertTemplate
}
DeleteAlertStrategyTemplateResponse is response schema for DeleteAlertStrategyTemplate action
type EnableAlertStrategyRequest ¶ added in v0.22.110
type EnableAlertStrategyRequest struct {
request.CommonBase
// 告警策略id
AlertStrategyID *int `required:"true"`
// 启用状态0 停用 1 启用
Status *int `required:"true"`
}
EnableAlertStrategyRequest is request schema for EnableAlertStrategy action
type EnableAlertStrategyResponse ¶ added in v0.22.110
type EnableAlertStrategyResponse struct {
response.CommonBase
// 返回数据
Data AlertStrategyId
}
EnableAlertStrategyResponse is response schema for EnableAlertStrategy action
type GetMetricDataAggregationMethodRequest ¶ added in v0.22.110
type GetMetricDataAggregationMethodRequest struct {
request.CommonBase
}
GetMetricDataAggregationMethodRequest is request schema for GetMetricDataAggregationMethod action
type GetMetricDataAggregationMethodResp ¶ added in v0.22.110
type GetMetricDataAggregationMethodResp struct {
// 聚合方式列表
List []MetricDataAggregationMethod
}
GetMetricDataAggregationMethodResp - 获取指标数据聚合方式返回结构
type GetMetricDataAggregationMethodResponse ¶ added in v0.22.110
type GetMetricDataAggregationMethodResponse struct {
response.CommonBase
// 获取指标数据聚合方式返回结果
Data GetMetricDataAggregationMethodResp
}
GetMetricDataAggregationMethodResponse is response schema for GetMetricDataAggregationMethod action
type GetProductMetricsRequest ¶
type GetProductMetricsRequest struct {
request.CommonBase
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
}
GetProductMetricsRequest is request schema for GetProductMetrics action
type GetProductMetricsRespData ¶
type GetProductMetricsRespData struct {
// 指标列表
List []Metirc
// 查询结果总数
Total int
// 单位转换信息
UnitConfigs []MetricUnitConfig
}
GetProductMetricsRespData - 产品指标查询结果
type GetProductMetricsResponse ¶
type GetProductMetricsResponse struct {
response.CommonBase
// 返回数据
Data GetProductMetricsRespData
}
GetProductMetricsResponse is response schema for GetProductMetrics action
type LabelAttrItem ¶ added in v0.22.111
LabelAttrItem - 标签扩展属性项
type ListAlertRecordParamFilter ¶
type ListAlertRecordParamFilter struct {
// 告警级别,根据告警级别精确搜索对应的告警记录,枚举值:P0,P1,P2,P3
Levels []string `required:"false"`
// 产品ID,根据产品类型精确搜索对应的告警记录,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductTypes []int `required:"false"`
// 告警状态,根据告警状态精确搜索对应的告警记录,枚举值:firing-告警中,resolved-已恢复
Status []string `required:"false"`
}
ListAlertRecordParamFilter is request schema for complex param
type ListAlertRecordRequest ¶
type ListAlertRecordRequest struct {
request.CommonBase
// 结束时间,查询告警记录结束时间(查询开始时间和结束时间不能超过一个月),值为10位数时间戳
EndAt *int `required:"true"`
//
Filter *ListAlertRecordParamFilter `required:"false"`
// 模糊查询(支持资源id模糊搜索)
Fuzzy *string `required:"false"`
// 查询返回数量,默认值300,最大值:300。
Limit *int `required:"false"`
// 数据偏移量 (默认0)
Offset *int `required:"false"`
// 排序(默认根据告警发生时间倒序),枚举值:asc-升序,desc-降序
OrderType *string `required:"false"`
// 开始时间,查询告警记录开始时间,不支持查询距当前时间一年前的数据),值为10位数时间戳
StartAt *int `required:"true"`
}
ListAlertRecordRequest is request schema for ListAlertRecord action
type ListAlertRecordResponse ¶
type ListAlertRecordResponse struct {
response.CommonBase
// 告警记录集合
Data []AlertRecord
// 告警记录总数
TotalCount int
}
ListAlertRecordResponse is response schema for ListAlertRecord action
type ListAlertStrategyParamFilter ¶
type ListAlertStrategyParamFilter struct {
// 告警策略id,根据策略id获取告警策略列表
AlertStrategyIDs []int `required:"false"`
// 产品ID,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductTypes []int `required:"false"`
// 告警策略状态,根据告警策略状态精确搜索对应的告警策略,枚举值:0-停用,1-启用
Status []int `required:"false"`
}
ListAlertStrategyParamFilter is request schema for complex param
type ListAlertStrategyRequest ¶
type ListAlertStrategyRequest struct {
request.CommonBase
//
Filter *ListAlertStrategyParamFilter `required:"false"`
// 模糊查询(支持告警策略名称模糊搜索)
Fuzzy *string `required:"false"`
// 查询返回数量,默认值300,最大值:300。
Limit *int `required:"false"`
// 数据偏移量 (默认0)
Offset *int `required:"false"`
// 资源id集合,根据资源id返回绑定的告警策略列表
Resources []string `required:"false"`
}
ListAlertStrategyRequest is request schema for ListAlertStrategy action
type ListAlertStrategyResponse ¶
type ListAlertStrategyResponse struct {
response.CommonBase
// 告警策略集合
Data []AlertStrategy
// 错误信息
Message string
// 告警策略总数
TotalCount int
// 链路ID
TraceId string
}
ListAlertStrategyResponse is response schema for ListAlertStrategy action
type ListAlertStrategyTemplateParamFilter ¶ added in v0.22.110
type ListAlertStrategyTemplateParamFilter struct {
// 模板id集合,根据模板id获取告警条件模板列表
TemplateIDs []int `required:"false"`
}
ListAlertStrategyTemplateParamFilter is request schema for complex param
type ListAlertStrategyTemplateRequest ¶ added in v0.22.110
type ListAlertStrategyTemplateRequest struct {
request.CommonBase
//
Filter *ListAlertStrategyTemplateParamFilter `required:"false"`
// 查询返回数量,默认值300,最大值:300。
Limit *int `required:"false"`
// 数据偏移量 (默认0)
Offset *int `required:"false"`
}
ListAlertStrategyTemplateRequest is request schema for ListAlertStrategyTemplate action
type ListAlertStrategyTemplateResponse ¶ added in v0.22.110
type ListAlertStrategyTemplateResponse struct {
response.CommonBase
// 条件模板列表
Data []ListAlertTemplate
// 错误信息
Message string
// 条件模板总条数
TotalCount int
}
ListAlertStrategyTemplateResponse is response schema for ListAlertStrategyTemplate action
type ListAlertTemplate ¶ added in v0.22.110
type ListAlertTemplate struct {
// 公司id
CompanyID int
// 告警模板名称
Name string
// 产品类型(字符型)。参考ListMonitorProduct获取监控对象类型列表
ProductKey string
// 产品类型(数值型)。参考ListMonitorProduct获取监控对象类型列表
ProductType int
// 条件模板备注
Remark string
// 告警条件规则
RuleSet []AlertRule
// 模板Id
TemplateID int
}
ListAlertTemplate -
type ListMonitorProduct ¶
ListMonitorProduct -
type ListMonitorProductRequest ¶
type ListMonitorProductRequest struct {
request.CommonBase
}
ListMonitorProductRequest is request schema for ListMonitorProduct action
type ListMonitorProductResponse ¶
type ListMonitorProductResponse struct {
response.CommonBase
// 返回数据
Data ListMonitorProduct
// 错误信息
Message string
// 链路ID
TraceId string
}
ListMonitorProductResponse is response schema for ListMonitorProduct action
type Metirc ¶
type Metirc struct {
// 创建时间
CreatedAt string
// 创建者
CreatedBy string
// 上报频率毫秒
FrequencyMs int
// 指标唯一标识 (uhost_cpu_usage)
Metric string
// 指标中文描述
MetricChDesc string
// 指标中文名称
MetricChName string
// 指标英文描述
MetricEnDesc string
// 指标英文名称
MetricEnName string
// 指标分类/指标组
MetricGroup string
// 指标ID
MetricID int
// 云产品ID
ProductType int
// 单位
Unit MetricUnit
// 单位ID
UnitID int
// 修改时间
UpdatedAt string
// 修改者
UpdatedBy string
}
Metirc - 指标
type MetricDataAggregationMethod ¶ added in v0.22.110
type MetricDataAggregationMethod struct {
// 描述
Description string
// 是否是默认方式
IsDefault bool
// 标签
Label string
// 值
Value string
}
MetricDataAggregationMethod - 指标数据聚合方式
type MetricResult ¶
type MetricResult struct {
// 资源的短id
ResourceId string
// 资源名称
ResourceName string
// 资源标签列表。每项为 TagListItem:Tag(标签名)和 TagValue(标签值)。
TagList []TagListItem
// 指标数据点列表,元素为 MetricPoint
Values []MetricSample
}
MetricResult - 单条时间序列的结果(代码结构体:MetricValues)
type MetricSample ¶
MetricSample - 指标数据点(代码结构体:MetricPoint)
type MetricSingleSample ¶
type MetricSingleSample struct {
// 指标名
Metric string
// 指标标签列表
TagsList []TagListItem
// 指标单个样本点对象
Value MetricSample
}
MetricSingleSample - 指标单个样本点结果
type MetricUnit ¶
type MetricUnit struct {
// 转换因子
ConversionFactor int
// 创建时间
CreatedAt string
// 创建人
CreatedBy string
// 删除时间
DeletedAt int
// GroupId
GroupId int
// 单位中文名称
UnitChName string
// 单位描述
UnitDesc string
// 单位英文名称
UnitEnName string
// 单位id
UnitID int
// 修改时间
UpdatedAt string
// 修改人
UpdatedBy string
}
MetricUnit - 指标单位
type MetricUnitConfig ¶
type MetricUnitConfig struct {
// 转换因子
ConversionFactor int
// 转换规则
ConversionRules []ConversionRule
// 指标中文名列表
UnitCnNames []string
// 指标英文名列表
UnitEnNames []string
}
MetricUnitConfig - 指标单位配置
type ModifyAlertStrategyRemarkRequest ¶ added in v0.22.110
type ModifyAlertStrategyRemarkRequest struct {
request.CommonBase
// 策略id
AlertStrategyID *int `required:"true"`
// 策略名称
Name *string `required:"true"`
// 策略备注
Remark *string `required:"false"`
}
ModifyAlertStrategyRemarkRequest is request schema for ModifyAlertStrategyRemark action
type ModifyAlertStrategyRemarkResponse ¶ added in v0.22.110
type ModifyAlertStrategyRemarkResponse struct {
response.CommonBase
// 返回数据
Data AlertStrategyId
}
ModifyAlertStrategyRemarkResponse is response schema for ModifyAlertStrategyRemark action
type Product ¶
type Product struct {
// ID
Id int
// {Type: 1|2, Key:string, Name: string}[] -> JSON字符串
Metas string
// 产品中文名称
ProductChName string
// 产品英文名称
ProductEnName string
// 产品分组
ProductGroup string
// 资源类型唯一key
ProductKey string
// 产品名称
ProductName string
// 产品子名称
ProductName1 string
// 资源类型ID
ProductType int
}
Product - 云产品
type QueryMetricDataResp ¶
type QueryMetricDataResp struct {
// 无效或无权限资源的 ID 列表
InvalidResourceIds []string
// 查询的结果集
List []QueryMetricDataRespItem
}
QueryMetricDataResp - QueryMetricDataSet 接口返回的结果
type QueryMetricDataRespItem ¶
type QueryMetricDataRespItem struct {
// 该指标查询的处理状态码
ErrCode int
// 该指标查询的状态说明
ErrMsg string
// 指标名
Metric string
// 查询到的时间序列列表
Results []MetricResult
// 标签列表。每项为 TagEntry:TagName(标签名)和 KeyList(该标签的全部候选值)。
TagEntries []TagEntry
}
QueryMetricDataRespItem - 单个监控指标的查询结果
type QueryMetricDataSetParamMetricInfos ¶
type QueryMetricDataSetParamMetricInfos struct {
// 指标名,参数中N的取值范围为 0~9
Metric *string `required:"true"`
// 指标所属资源id,参数中N的取值范围为 0~9
ResourceId *string `required:"true"`
//
TagList []QueryMetricDataSetParamMetricInfosTagList `required:"false"`
// 多个 Tag 条件的匹配方式;可选 and(默认)或 or。TagList 中使用 or 时最多支持 3 个 Tag。
TagOperation *string `required:"false"`
}
QueryMetricDataSetParamMetricInfos is request schema for complex param
type QueryMetricDataSetParamMetricInfosTagList ¶
type QueryMetricDataSetParamMetricInfosTagList struct {
// 要查询指标的Tag的key,参数中N的取值范围为 0~9
TagKey *string `required:"false"`
// 要查询指标的Tag的Value,参数中N的取值范围为 0~9
TagValues []string `required:"false"`
}
QueryMetricDataSetParamMetricInfosTagList is request schema for complex param
type QueryMetricDataSetRequest ¶
type QueryMetricDataSetRequest struct {
request.CommonBase
// 计算方式,枚举值如下:raw:原始值,max:最大值,min:最小值,avg:平均值,sum:求和
CalcMethod *string `required:"true"`
// 截止时间,值为10位数时间戳
EndTime *int `required:"true"`
//
MetricInfos []QueryMetricDataSetParamMetricInfos `required:"false"`
// 周期,单位为秒,即:数据查询时,返回数据点的时间间隔。不同的查询时间范围,对应的周期不同:0<时间范围<=1h——周期:1分钟/5分钟,对应的枚举值为60、300;1h<时间范围<=12h——周期:1分钟/5分钟/1小时,对应的枚举值为60、300、3600;12h<时间范围<=24h——周期:5分钟/1小时,对应的枚举值为300、3600;1天<时间范围<=30天——周期:1小时/6小时/24小时,对应的枚举值为3600、21600、86400
Period *int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 开始时间,值为10位数时间戳
StartTime *int `required:"true"`
}
QueryMetricDataSetRequest is request schema for QueryMetricDataSet action
type QueryMetricDataSetResponse ¶
type QueryMetricDataSetResponse struct {
response.CommonBase
// QueryMetricDataResp
Data QueryMetricDataResp
// 错误信息
Message string
// 日志链路id
TraceId string
}
QueryMetricDataSetResponse is response schema for QueryMetricDataSet action
type QueryMetricDataSummaryRequest ¶
type QueryMetricDataSummaryRequest struct {
request.CommonBase
// 当前页数据尺寸
Limit *int `required:"true"`
// 指定要查询的指标列表,不指定则使用默认的指标集合
Metrics []string `required:"false"`
// 跳过的数量
Offset *int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 指定要查询的资源ID列表
ResourceIds []string `required:"false"`
}
QueryMetricDataSummaryRequest is request schema for QueryMetricDataSummary action
type QueryMetricDataSummaryRespData ¶
type QueryMetricDataSummaryRespData struct {
// 结果集
List []ResourceSummary
// 总数
Total int
}
QueryMetricDataSummaryRespData - QueryMetricDataSummary接口返回的Data数据
type QueryMetricDataSummaryResponse ¶
type QueryMetricDataSummaryResponse struct {
response.CommonBase
// 数据
Data QueryMetricDataSummaryRespData
// 错误信息
Message string
// 总数
TotalCount int
// 链路id
TraceId string
}
QueryMetricDataSummaryResponse is response schema for QueryMetricDataSummary action
type ResourceExtendAttrItem ¶ added in v0.22.111
ResourceExtendAttrItem - 资源扩展属性项
type ResourceMonitorItem ¶
type ResourceMonitorItem struct {
// 指标名
Metric string
// 指标数据数组
MetricValues []MetricSingleSample
}
ResourceMonitorItem - 资源监控的单个指标数据
type ResourceSummary ¶
type ResourceSummary struct {
// 公司id
CompanyId int
// 资源标签属性列表
LabelAttrList []LabelAttrItem
// 资源的各项指标当前值列表
MonitorAttr []ResourceMonitorItem
// 资源名称
Name string
// 项目id
OrganizationId int
// 产品类型
ProductKey string
// 项目id
ProjectId int
// 地域
Region string
// 地域中文名
RegionCN string
// 资源扩展属性列表
ResourceExtendAttrList []ResourceExtendAttrItem
// 资源id
ResourceId string
// 资源状态
Status int
// 可用区
Zone string
// 可用区中文
ZoneCN string
}
ResourceSummary - 单个资源的总览属性指标等信息
type TagListItem ¶ added in v0.22.111
TagListItem - 标签键值项
type UnBindAlertStrategyRequest ¶
type UnBindAlertStrategyRequest struct {
request.CommonBase
// 告警策略数组
AlertStrategyIDs []int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 资源数组
Resources []string `required:"true"`
}
UnBindAlertStrategyRequest is request schema for UnBindAlertStrategy action
type UnBindAlertStrategyResponse ¶
type UnBindAlertStrategyResponse struct {
response.CommonBase
}
UnBindAlertStrategyResponse is response schema for UnBindAlertStrategy action
type UpdateAlertStrategyParamRuleSet ¶ added in v0.22.110
type UpdateAlertStrategyParamRuleSet struct {
// 告警等级。枚举值:P0,P1,P2,P3
Level *string `required:"false"`
// 规则指标ID。参考该类型产品下返回的指标列表GetProductMetrics
MetricID *int `required:"false"`
// 沉默周期(告警周期选择为连续时必填)
SendInterval *int `required:"false"`
// 触发周期。枚举值:continuous连续 exponent 指数 single 不重复
SendPeriodType *string `required:"false"`
// 告警状态。枚举值:0-关闭 1-开启
Status *int `required:"false"`
// 阈值比较方式。 枚举值:1:>= 2:<= 3:> 4:< 5:== 6:!=
ThresholdCompare *int `required:"false"`
// 触发阈值
ThresholdValue *int `required:"false"`
// 触发次数
TriggerCount *int `required:"false"`
}
UpdateAlertStrategyParamRuleSet is request schema for complex param
type UpdateAlertStrategyRequest ¶ added in v0.22.110
type UpdateAlertStrategyRequest struct {
request.CommonBase
// 告警策略id
AlertStrategyID *string `required:"true"`
// 通知渠道回调webhook 回调语言 中文cn 英文en
CallbackLanguage *string `required:"false"`
// 回调url
CallbackUrls []string `required:"false"`
// 条件设置方式 1. 手动配置 2.选择模版
ConfigMode *int `required:"true"`
// 告警策略名称。最大长度255个字符
Name *string `required:"true"`
// 通知渠道 短信sms 邮件email 回调webhook
NotifyChannelDs []string `required:"false"`
// 通知人组id
NotifyGroupIDs []int `required:"false"`
// 通知类型 通知组 group 通知人 user
NotifyType *string `required:"false"`
// 通知人id
NotifyUserIDs []int `required:"false"`
// 绑定资源类型 1 资源组 2 资源
ObjectType *int `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 绑定资源组,对应绑定资源类型ObjectType=1
ResourceGroupIDs []int `required:"false"`
// 绑定资源,对应绑定资源类型ObjectType=2
Resources []string `required:"false"`
//
RuleSet []UpdateAlertStrategyParamRuleSet `required:"false"`
// 模板id.对应ConfigMode=2
TemplateId *int `required:"false"`
}
UpdateAlertStrategyRequest is request schema for UpdateAlertStrategy action
type UpdateAlertStrategyResponse ¶ added in v0.22.110
type UpdateAlertStrategyResponse struct {
response.CommonBase
// 更新告警策略返回对象
Data AlertStrategyId
}
UpdateAlertStrategyResponse is response schema for UpdateAlertStrategy action
type UpdateAlertStrategyTemplateParamRuleSet ¶ added in v0.22.110
type UpdateAlertStrategyTemplateParamRuleSet struct {
// 告警等级。枚举值:P0,P1,P2,P3
Level *string `required:"true"`
// 规则指标ID。参考该类型产品下返回的指标列表GetProductMetrics
MetricID *int `required:"true"`
// 沉默周期(告警周期选择为连续时必填)
SendInterval *int `required:"false"`
// 触发周期。枚举值:continuous连续 exponent 指数 single 不重复
SendPeriodType *string `required:"true"`
// 告警状态。枚举值:0-关闭 1-开启
Status *int `required:"true"`
// 阈值比较方式。枚举值比较方式: 1->=2-<= 3-> 4-< 5-== 6-!=
ThresholdCompare *int `required:"true"`
// 触发阈值
ThresholdValue *int `required:"true"`
// 触发次数
TriggerCount *int `required:"true"`
}
UpdateAlertStrategyTemplateParamRuleSet is request schema for complex param
type UpdateAlertStrategyTemplateRequest ¶ added in v0.22.110
type UpdateAlertStrategyTemplateRequest struct {
request.CommonBase
// 告警模板名称。最大长度64个字符
Name *string `required:"true"`
// 产品唯一标识,参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro)
ProductKey *string `required:"true"`
// 备注
Remark *string `required:"false"`
//
RuleSet []UpdateAlertStrategyTemplateParamRuleSet `required:"false"`
// 条件模板ID
TemplateID *int `required:"true"`
}
UpdateAlertStrategyTemplateRequest is request schema for UpdateAlertStrategyTemplate action
type UpdateAlertStrategyTemplateResponse ¶ added in v0.22.110
type UpdateAlertStrategyTemplateResponse struct {
response.CommonBase
// 更新条件模板ID
Data AlertTemplate
}
UpdateAlertStrategyTemplateResponse is response schema for UpdateAlertStrategyTemplate action