如果您需要监控某一云产品资源的数据状态,则可以创建云监控告警策略。当被监控的云产品资源数据达到告警的触发条件时,系统会通过您指定的方式推送告警通知,便于您及时发现存在异常数据的资源。
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
cloudMonitorRuleDemo:
type: bytepluscc:cloudmonitor:Rule
name: CloudMonitorRuleDemo
properties:
ruleName: CloudMonitorRuleDemo
description: this is a description
ruleType: static
namespace: VCM_AgentKitMcp
subNamespace: MCP_Service
originalDimensions:
key: ResourceID
values:
- '*'
level: warning
evaluationCount: 1
enableState: enable
regions:
- cn-beijing
multipleConditions: false
noData:
enable: false
evaluation_count: 4
levelConditions:
- level: warning
conditions:
- metricName: istio_requests_total
statistics: sum
comparisonOperator: '>'
threshold: '100000'
metricUnit: Count
conditions:
- metric_name: istio_requests_total
statistics: sum
comparison_operator: '>'
threshold: '100000'
metric_unit: Count
conditionOperator: '&&'
silenceTime: 5
recoveryNotify:
enable: true
projectName: default
tags:
- key: env
value: test
alertMethods:
- Email
- Webhook
webhookIds:
- 2005838xxxxx67xxxxx
contactGroupIds:
- 20041xxxxxx06xxxxx
effectStartAt: 00:00
effectEndAt: 23:59
Create Rule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);@overload
def Rule(resource_name: str,
args: RuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Rule(resource_name: str,
opts: Optional[ResourceOptions] = None,
rule_name: Optional[str] = None,
silence_time: Optional[int] = None,
sub_namespace: Optional[str] = None,
namespace: Optional[str] = None,
rule_type: Optional[str] = None,
level: Optional[str] = None,
effect_end_at: Optional[str] = None,
effect_start_at: Optional[str] = None,
enable_state: Optional[str] = None,
evaluation_count: Optional[int] = None,
recovery_notify: Optional[RuleRecoveryNotifyArgs] = None,
regions: Optional[Sequence[str]] = None,
project_name: Optional[str] = None,
multiple_conditions: Optional[bool] = None,
description: Optional[str] = None,
notification_id: Optional[str] = None,
notify_templates: Optional[Sequence[RuleNotifyTemplateArgs]] = None,
dimension_conditions: Optional[RuleDimensionConditionsArgs] = None,
level_conditions: Optional[Sequence[RuleLevelConditionArgs]] = None,
original_dimensions: Optional[RuleOriginalDimensionsArgs] = None,
condition_operator: Optional[str] = None,
alert_methods: Optional[Sequence[str]] = None,
no_data: Optional[RuleNoDataArgs] = None,
contact_group_ids: Optional[Sequence[str]] = None,
conditions: Optional[Sequence[RuleConditionArgs]] = None,
tags: Optional[Sequence[RuleTagArgs]] = None,
webhook: Optional[str] = None,
webhook_ids: Optional[Sequence[str]] = None)func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)type: bytepluscc:cloudmonitor:Rule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var byteplusccRuleResource = new Bytepluscc.Cloudmonitor.Rule("byteplusccRuleResource", new()
{
RuleName = "string",
SilenceTime = 0,
SubNamespace = "string",
Namespace = "string",
RuleType = "string",
Level = "string",
EffectEndAt = "string",
EffectStartAt = "string",
EnableState = "string",
EvaluationCount = 0,
RecoveryNotify = new Bytepluscc.Cloudmonitor.Inputs.RuleRecoveryNotifyArgs
{
Enable = false,
},
Regions = new[]
{
"string",
},
ProjectName = "string",
MultipleConditions = false,
Description = "string",
NotificationId = "string",
NotifyTemplates = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleNotifyTemplateArgs
{
Channel = "string",
NotifyTemplateId = "string",
},
},
DimensionConditions = new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsArgs
{
MetaCondition = new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsMetaConditionArgs
{
AllDimensions = false,
Condition = "string",
Metas = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsMetaConditionMetaArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
},
},
ProjectCondition = new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsProjectConditionArgs
{
Projects = new[]
{
"string",
},
},
TagCondition = new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsTagConditionArgs
{
Condition = "string",
Tags = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleDimensionConditionsTagConditionTagArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
},
},
Type = "string",
},
LevelConditions = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleLevelConditionArgs
{
Conditions = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleLevelConditionConditionArgs
{
ComparisonOperator = "string",
MetricName = "string",
MetricUnit = "string",
Period = "string",
Statistics = "string",
Threshold = "string",
},
},
Level = "string",
},
},
OriginalDimensions = new Bytepluscc.Cloudmonitor.Inputs.RuleOriginalDimensionsArgs
{
Key = "string",
Values = new[]
{
"string",
},
},
ConditionOperator = "string",
AlertMethods = new[]
{
"string",
},
NoData = new Bytepluscc.Cloudmonitor.Inputs.RuleNoDataArgs
{
Enable = false,
EvaluationCount = 0,
},
ContactGroupIds = new[]
{
"string",
},
Conditions = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleConditionArgs
{
ComparisonOperator = "string",
MetricName = "string",
MetricUnit = "string",
Period = "string",
Statistics = "string",
Threshold = "string",
},
},
Tags = new[]
{
new Bytepluscc.Cloudmonitor.Inputs.RuleTagArgs
{
Key = "string",
Value = "string",
},
},
Webhook = "string",
WebhookIds = new[]
{
"string",
},
});
example, err := cloudmonitor.NewRule(ctx, "byteplusccRuleResource", &cloudmonitor.RuleArgs{
RuleName: pulumi.String("string"),
SilenceTime: pulumi.Int(0),
SubNamespace: pulumi.String("string"),
Namespace: pulumi.String("string"),
RuleType: pulumi.String("string"),
Level: pulumi.String("string"),
EffectEndAt: pulumi.String("string"),
EffectStartAt: pulumi.String("string"),
EnableState: pulumi.String("string"),
EvaluationCount: pulumi.Int(0),
RecoveryNotify: &cloudmonitor.RuleRecoveryNotifyArgs{
Enable: pulumi.Bool(false),
},
Regions: pulumi.StringArray{
pulumi.String("string"),
},
ProjectName: pulumi.String("string"),
MultipleConditions: pulumi.Bool(false),
Description: pulumi.String("string"),
NotificationId: pulumi.String("string"),
NotifyTemplates: cloudmonitor.RuleNotifyTemplateArray{
&cloudmonitor.RuleNotifyTemplateArgs{
Channel: pulumi.String("string"),
NotifyTemplateId: pulumi.String("string"),
},
},
DimensionConditions: &cloudmonitor.RuleDimensionConditionsArgs{
MetaCondition: &cloudmonitor.RuleDimensionConditionsMetaConditionArgs{
AllDimensions: pulumi.Bool(false),
Condition: pulumi.String("string"),
Metas: cloudmonitor.RuleDimensionConditionsMetaConditionMetaArray{
&cloudmonitor.RuleDimensionConditionsMetaConditionMetaArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
ProjectCondition: &cloudmonitor.RuleDimensionConditionsProjectConditionArgs{
Projects: pulumi.StringArray{
pulumi.String("string"),
},
},
TagCondition: &cloudmonitor.RuleDimensionConditionsTagConditionArgs{
Condition: pulumi.String("string"),
Tags: cloudmonitor.RuleDimensionConditionsTagConditionTagArray{
&cloudmonitor.RuleDimensionConditionsTagConditionTagArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Type: pulumi.String("string"),
},
LevelConditions: cloudmonitor.RuleLevelConditionArray{
&cloudmonitor.RuleLevelConditionArgs{
Conditions: cloudmonitor.RuleLevelConditionConditionArray{
&cloudmonitor.RuleLevelConditionConditionArgs{
ComparisonOperator: pulumi.String("string"),
MetricName: pulumi.String("string"),
MetricUnit: pulumi.String("string"),
Period: pulumi.String("string"),
Statistics: pulumi.String("string"),
Threshold: pulumi.String("string"),
},
},
Level: pulumi.String("string"),
},
},
OriginalDimensions: &cloudmonitor.RuleOriginalDimensionsArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
ConditionOperator: pulumi.String("string"),
AlertMethods: pulumi.StringArray{
pulumi.String("string"),
},
NoData: &cloudmonitor.RuleNoDataArgs{
Enable: pulumi.Bool(false),
EvaluationCount: pulumi.Int(0),
},
ContactGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Conditions: cloudmonitor.RuleConditionArray{
&cloudmonitor.RuleConditionArgs{
ComparisonOperator: pulumi.String("string"),
MetricName: pulumi.String("string"),
MetricUnit: pulumi.String("string"),
Period: pulumi.String("string"),
Statistics: pulumi.String("string"),
Threshold: pulumi.String("string"),
},
},
Tags: cloudmonitor.RuleTagArray{
&cloudmonitor.RuleTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Webhook: pulumi.String("string"),
WebhookIds: pulumi.StringArray{
pulumi.String("string"),
},
})
var byteplusccRuleResource = new com.byteplus.bytepluscc.cloudmonitor.Rule("byteplusccRuleResource", com.byteplus.bytepluscc.cloudmonitor.RuleArgs.builder()
.ruleName("string")
.silenceTime(0)
.subNamespace("string")
.namespace("string")
.ruleType("string")
.level("string")
.effectEndAt("string")
.effectStartAt("string")
.enableState("string")
.evaluationCount(0)
.recoveryNotify(RuleRecoveryNotifyArgs.builder()
.enable(false)
.build())
.regions("string")
.projectName("string")
.multipleConditions(false)
.description("string")
.notificationId("string")
.notifyTemplates(RuleNotifyTemplateArgs.builder()
.channel("string")
.notifyTemplateId("string")
.build())
.dimensionConditions(RuleDimensionConditionsArgs.builder()
.metaCondition(RuleDimensionConditionsMetaConditionArgs.builder()
.allDimensions(false)
.condition("string")
.metas(RuleDimensionConditionsMetaConditionMetaArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.build())
.projectCondition(RuleDimensionConditionsProjectConditionArgs.builder()
.projects("string")
.build())
.tagCondition(RuleDimensionConditionsTagConditionArgs.builder()
.condition("string")
.tags(RuleDimensionConditionsTagConditionTagArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.build())
.type("string")
.build())
.levelConditions(RuleLevelConditionArgs.builder()
.conditions(RuleLevelConditionConditionArgs.builder()
.comparisonOperator("string")
.metricName("string")
.metricUnit("string")
.period("string")
.statistics("string")
.threshold("string")
.build())
.level("string")
.build())
.originalDimensions(RuleOriginalDimensionsArgs.builder()
.key("string")
.values("string")
.build())
.conditionOperator("string")
.alertMethods("string")
.noData(RuleNoDataArgs.builder()
.enable(false)
.evaluationCount(0)
.build())
.contactGroupIds("string")
.conditions(RuleConditionArgs.builder()
.comparisonOperator("string")
.metricName("string")
.metricUnit("string")
.period("string")
.statistics("string")
.threshold("string")
.build())
.tags(RuleTagArgs.builder()
.key("string")
.value("string")
.build())
.webhook("string")
.webhookIds("string")
.build());
bytepluscc_rule_resource = bytepluscc.cloudmonitor.Rule("byteplusccRuleResource",
rule_name="string",
silence_time=0,
sub_namespace="string",
namespace="string",
rule_type="string",
level="string",
effect_end_at="string",
effect_start_at="string",
enable_state="string",
evaluation_count=0,
recovery_notify={
"enable": False,
},
regions=["string"],
project_name="string",
multiple_conditions=False,
description="string",
notification_id="string",
notify_templates=[{
"channel": "string",
"notify_template_id": "string",
}],
dimension_conditions={
"meta_condition": {
"all_dimensions": False,
"condition": "string",
"metas": [{
"comparator": "string",
"key": "string",
"values": ["string"],
}],
},
"project_condition": {
"projects": ["string"],
},
"tag_condition": {
"condition": "string",
"tags": [{
"comparator": "string",
"key": "string",
"values": ["string"],
}],
},
"type": "string",
},
level_conditions=[{
"conditions": [{
"comparison_operator": "string",
"metric_name": "string",
"metric_unit": "string",
"period": "string",
"statistics": "string",
"threshold": "string",
}],
"level": "string",
}],
original_dimensions={
"key": "string",
"values": ["string"],
},
condition_operator="string",
alert_methods=["string"],
no_data={
"enable": False,
"evaluation_count": 0,
},
contact_group_ids=["string"],
conditions=[{
"comparison_operator": "string",
"metric_name": "string",
"metric_unit": "string",
"period": "string",
"statistics": "string",
"threshold": "string",
}],
tags=[{
"key": "string",
"value": "string",
}],
webhook="string",
webhook_ids=["string"])
const byteplusccRuleResource = new bytepluscc.cloudmonitor.Rule("byteplusccRuleResource", {
ruleName: "string",
silenceTime: 0,
subNamespace: "string",
namespace: "string",
ruleType: "string",
level: "string",
effectEndAt: "string",
effectStartAt: "string",
enableState: "string",
evaluationCount: 0,
recoveryNotify: {
enable: false,
},
regions: ["string"],
projectName: "string",
multipleConditions: false,
description: "string",
notificationId: "string",
notifyTemplates: [{
channel: "string",
notifyTemplateId: "string",
}],
dimensionConditions: {
metaCondition: {
allDimensions: false,
condition: "string",
metas: [{
comparator: "string",
key: "string",
values: ["string"],
}],
},
projectCondition: {
projects: ["string"],
},
tagCondition: {
condition: "string",
tags: [{
comparator: "string",
key: "string",
values: ["string"],
}],
},
type: "string",
},
levelConditions: [{
conditions: [{
comparisonOperator: "string",
metricName: "string",
metricUnit: "string",
period: "string",
statistics: "string",
threshold: "string",
}],
level: "string",
}],
originalDimensions: {
key: "string",
values: ["string"],
},
conditionOperator: "string",
alertMethods: ["string"],
noData: {
enable: false,
evaluationCount: 0,
},
contactGroupIds: ["string"],
conditions: [{
comparisonOperator: "string",
metricName: "string",
metricUnit: "string",
period: "string",
statistics: "string",
threshold: "string",
}],
tags: [{
key: "string",
value: "string",
}],
webhook: "string",
webhookIds: ["string"],
});
type: bytepluscc:cloudmonitor:Rule
properties:
alertMethods:
- string
conditionOperator: string
conditions:
- comparisonOperator: string
metricName: string
metricUnit: string
period: string
statistics: string
threshold: string
contactGroupIds:
- string
description: string
dimensionConditions:
metaCondition:
allDimensions: false
condition: string
metas:
- comparator: string
key: string
values:
- string
projectCondition:
projects:
- string
tagCondition:
condition: string
tags:
- comparator: string
key: string
values:
- string
type: string
effectEndAt: string
effectStartAt: string
enableState: string
evaluationCount: 0
level: string
levelConditions:
- conditions:
- comparisonOperator: string
metricName: string
metricUnit: string
period: string
statistics: string
threshold: string
level: string
multipleConditions: false
namespace: string
noData:
enable: false
evaluationCount: 0
notificationId: string
notifyTemplates:
- channel: string
notifyTemplateId: string
originalDimensions:
key: string
values:
- string
projectName: string
recoveryNotify:
enable: false
regions:
- string
ruleName: string
ruleType: string
silenceTime: 0
subNamespace: string
tags:
- key: string
value: string
webhook: string
webhookIds:
- string
Rule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Rule resource accepts the following input properties:
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- Rule
Name string - 告警策略名称。
- Rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- Silence
Time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- Sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- Alert
Methods List<string> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- Condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- Conditions
List<Byteplus.
Rule Condition> - Contact
Group List<string>Ids - 告警策略绑定的告警通知组 ID。
- Description string
- 告警策略描述信息。
- Dimension
Conditions Byteplus.Rule Dimension Conditions - Dimension 配置。
- Level
Conditions List<Byteplus.Rule Level Condition> - Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- No
Data Byteplus.Rule No Data - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates List<Byteplus.Rule Notify Template> - Original
Dimensions Byteplus.Rule Original Dimensions - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify Byteplus.Rule Recovery Notify - 告警恢复通知。
- Regions List<string>
- 云产品所属可用区 ID。
-
List<Byteplus.
Rule Tag> - Webhook string
- 告警策略绑定的告警回调 URL 地址。
- Webhook
Ids List<string> - 告警发生时告警回调 ID 列表。
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- Rule
Name string - 告警策略名称。
- Rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- Silence
Time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- Sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- Alert
Methods []string - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- Condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- Conditions
[]Rule
Condition Args - Contact
Group []stringIds - 告警策略绑定的告警通知组 ID。
- Description string
- 告警策略描述信息。
- Dimension
Conditions RuleDimension Conditions Args - Dimension 配置。
- Level
Conditions []RuleLevel Condition Args - Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- No
Data RuleNo Data Args - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates []RuleNotify Template Args - Original
Dimensions RuleOriginal Dimensions Args - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify RuleRecovery Notify Args - 告警恢复通知。
- Regions []string
- 云产品所属可用区 ID。
-
[]Rule
Tag Args - Webhook string
- 告警策略绑定的告警回调 URL 地址。
- Webhook
Ids []string - 告警发生时告警回调 ID 列表。
- effect
End StringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start StringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State String - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count Integer - 触发告警需要持续的周期。单位为分钟。
- level String
- 告警级别。critical:严重,warning:警告,notice:通知
- namespace String
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- rule
Name String - 告警策略名称。
- rule
Type String - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time Integer - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace String - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- alert
Methods List<String> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- condition
Operator String - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
List<Rule
Condition> - contact
Group List<String>Ids - 告警策略绑定的告警通知组 ID。
- description String
- 告警策略描述信息。
- dimension
Conditions RuleDimension Conditions - Dimension 配置。
- level
Conditions List<RuleLevel Condition> - multiple
Conditions Boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- no
Data RuleNo Data - 无数据告警。
- notification
Id String - 通知策略 ID。
- notify
Templates List<RuleNotify Template> - original
Dimensions RuleOriginal Dimensions - 告警策略检测的资源 ID。
- project
Name String - 告警策略所属项目。
- recovery
Notify RuleRecovery Notify - 告警恢复通知。
- regions List<String>
- 云产品所属可用区 ID。
-
List<Rule
Tag> - webhook String
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids List<String> - 告警发生时告警回调 ID 列表。
- effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count number - 触发告警需要持续的周期。单位为分钟。
- level string
- 告警级别。critical:严重,warning:警告,notice:通知
- namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- rule
Name string - 告警策略名称。
- rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time number - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- alert
Methods string[] - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
Rule
Condition[] - contact
Group string[]Ids - 告警策略绑定的告警通知组 ID。
- description string
- 告警策略描述信息。
- dimension
Conditions RuleDimension Conditions - Dimension 配置。
- level
Conditions RuleLevel Condition[] - multiple
Conditions boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- no
Data RuleNo Data - 无数据告警。
- notification
Id string - 通知策略 ID。
- notify
Templates RuleNotify Template[] - original
Dimensions RuleOriginal Dimensions - 告警策略检测的资源 ID。
- project
Name string - 告警策略所属项目。
- recovery
Notify RuleRecovery Notify - 告警恢复通知。
- regions string[]
- 云产品所属可用区 ID。
-
Rule
Tag[] - webhook string
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids string[] - 告警发生时告警回调 ID 列表。
- effect_
end_ strat - 策略生效的截止时间,格式为HH:MM。
- effect_
start_ strat - 告警策略生效的开始时间,格式为HH:MM。
- enable_
state str - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation_
count int - 触发告警需要持续的周期。单位为分钟。
- level str
- 告警级别。critical:严重,warning:警告,notice:通知
- namespace str
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- rule_
name str - 告警策略名称。
- rule_
type str - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence_
time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub_
namespace str - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- alert_
methods Sequence[str] - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- condition_
operator str - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
Sequence[Rule
Condition Args] - contact_
group_ Sequence[str]ids - 告警策略绑定的告警通知组 ID。
- description str
- 告警策略描述信息。
- dimension_
conditions RuleDimension Conditions Args - Dimension 配置。
- level_
conditions Sequence[RuleLevel Condition Args] - multiple_
conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- no_
data RuleNo Data Args - 无数据告警。
- notification_
id str - 通知策略 ID。
- notify_
templates Sequence[RuleNotify Template Args] - original_
dimensions RuleOriginal Dimensions Args - 告警策略检测的资源 ID。
- project_
name str - 告警策略所属项目。
- recovery_
notify RuleRecovery Notify Args - 告警恢复通知。
- regions Sequence[str]
- 云产品所属可用区 ID。
-
Sequence[Rule
Tag Args] - webhook str
- 告警策略绑定的告警回调 URL 地址。
- webhook_
ids Sequence[str] - 告警发生时告警回调 ID 列表。
- effect
End StringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start StringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State String - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count Number - 触发告警需要持续的周期。单位为分钟。
- level String
- 告警级别。critical:严重,warning:警告,notice:通知
- namespace String
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- rule
Name String - 告警策略名称。
- rule
Type String - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time Number - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace String - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- alert
Methods List<String> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- condition
Operator String - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions List<Property Map>
- contact
Group List<String>Ids - 告警策略绑定的告警通知组 ID。
- description String
- 告警策略描述信息。
- dimension
Conditions Property Map - Dimension 配置。
- level
Conditions List<Property Map> - multiple
Conditions Boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- no
Data Property Map - 无数据告警。
- notification
Id String - 通知策略 ID。
- notify
Templates List<Property Map> - original
Dimensions Property Map - 告警策略检测的资源 ID。
- project
Name String - 告警策略所属项目。
- recovery
Notify Property Map - 告警恢复通知。
- regions List<String>
- 云产品所属可用区 ID。
- List<Property Map>
- webhook String
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids List<String> - 告警发生时告警回调 ID 列表。
Outputs
All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:
- Alert
State string - 告警状态。 alerting:告警中 normal:正常。
- Created
At string - 告警策略创建时间,时间戳格式。
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Type string - 告警策略检测的资源类型。
- Rule
Id string - 告警策略 ID。
- Updated
At string - 告警策略更新时间,时间戳格式。
- Alert
State string - 告警状态。 alerting:告警中 normal:正常。
- Created
At string - 告警策略创建时间,时间戳格式。
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Type string - 告警策略检测的资源类型。
- Rule
Id string - 告警策略 ID。
- Updated
At string - 告警策略更新时间,时间戳格式。
- alert
State String - 告警状态。 alerting:告警中 normal:正常。
- created
At String - 告警策略创建时间,时间戳格式。
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Type String - 告警策略检测的资源类型。
- rule
Id String - 告警策略 ID。
- updated
At String - 告警策略更新时间,时间戳格式。
- alert
State string - 告警状态。 alerting:告警中 normal:正常。
- created
At string - 告警策略创建时间,时间戳格式。
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Type string - 告警策略检测的资源类型。
- rule
Id string - 告警策略 ID。
- updated
At string - 告警策略更新时间,时间戳格式。
- alert_
state str - 告警状态。 alerting:告警中 normal:正常。
- created_
at str - 告警策略创建时间,时间戳格式。
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
type str - 告警策略检测的资源类型。
- rule_
id str - 告警策略 ID。
- updated_
at str - 告警策略更新时间,时间戳格式。
- alert
State String - 告警状态。 alerting:告警中 normal:正常。
- created
At String - 告警策略创建时间,时间戳格式。
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Type String - 告警策略检测的资源类型。
- rule
Id String - 告警策略 ID。
- updated
At String - 告警策略更新时间,时间戳格式。
Look up Existing Rule Resource
Get an existing Rule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RuleState, opts?: CustomResourceOptions): Rule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alert_methods: Optional[Sequence[str]] = None,
alert_state: Optional[str] = None,
condition_operator: Optional[str] = None,
conditions: Optional[Sequence[RuleConditionArgs]] = None,
contact_group_ids: Optional[Sequence[str]] = None,
created_at: Optional[str] = None,
description: Optional[str] = None,
dimension_conditions: Optional[RuleDimensionConditionsArgs] = None,
effect_end_at: Optional[str] = None,
effect_start_at: Optional[str] = None,
enable_state: Optional[str] = None,
evaluation_count: Optional[int] = None,
level: Optional[str] = None,
level_conditions: Optional[Sequence[RuleLevelConditionArgs]] = None,
multiple_conditions: Optional[bool] = None,
namespace: Optional[str] = None,
no_data: Optional[RuleNoDataArgs] = None,
notification_id: Optional[str] = None,
notify_templates: Optional[Sequence[RuleNotifyTemplateArgs]] = None,
original_dimensions: Optional[RuleOriginalDimensionsArgs] = None,
project_name: Optional[str] = None,
recovery_notify: Optional[RuleRecoveryNotifyArgs] = None,
regions: Optional[Sequence[str]] = None,
resource_type: Optional[str] = None,
rule_id: Optional[str] = None,
rule_name: Optional[str] = None,
rule_type: Optional[str] = None,
silence_time: Optional[int] = None,
sub_namespace: Optional[str] = None,
tags: Optional[Sequence[RuleTagArgs]] = None,
updated_at: Optional[str] = None,
webhook: Optional[str] = None,
webhook_ids: Optional[Sequence[str]] = None) -> Rulefunc GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)resources: _: type: bytepluscc:cloudmonitor:Rule get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alert
Methods List<string> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- Alert
State string - 告警状态。 alerting:告警中 normal:正常。
- Condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- Conditions
List<Byteplus.
Rule Condition> - Contact
Group List<string>Ids - 告警策略绑定的告警通知组 ID。
- Created
At string - 告警策略创建时间,时间戳格式。
- Description string
- 告警策略描述信息。
- Dimension
Conditions Byteplus.Rule Dimension Conditions - Dimension 配置。
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Level
Conditions List<Byteplus.Rule Level Condition> - Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- No
Data Byteplus.Rule No Data - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates List<Byteplus.Rule Notify Template> - Original
Dimensions Byteplus.Rule Original Dimensions - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify Byteplus.Rule Recovery Notify - 告警恢复通知。
- Regions List<string>
- 云产品所属可用区 ID。
- Resource
Type string - 告警策略检测的资源类型。
- Rule
Id string - 告警策略 ID。
- Rule
Name string - 告警策略名称。
- Rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- Silence
Time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- Sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
-
List<Byteplus.
Rule Tag> - Updated
At string - 告警策略更新时间,时间戳格式。
- Webhook string
- 告警策略绑定的告警回调 URL 地址。
- Webhook
Ids List<string> - 告警发生时告警回调 ID 列表。
- Alert
Methods []string - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- Alert
State string - 告警状态。 alerting:告警中 normal:正常。
- Condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- Conditions
[]Rule
Condition Args - Contact
Group []stringIds - 告警策略绑定的告警通知组 ID。
- Created
At string - 告警策略创建时间,时间戳格式。
- Description string
- 告警策略描述信息。
- Dimension
Conditions RuleDimension Conditions Args - Dimension 配置。
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Level
Conditions []RuleLevel Condition Args - Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- No
Data RuleNo Data Args - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates []RuleNotify Template Args - Original
Dimensions RuleOriginal Dimensions Args - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify RuleRecovery Notify Args - 告警恢复通知。
- Regions []string
- 云产品所属可用区 ID。
- Resource
Type string - 告警策略检测的资源类型。
- Rule
Id string - 告警策略 ID。
- Rule
Name string - 告警策略名称。
- Rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- Silence
Time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- Sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
-
[]Rule
Tag Args - Updated
At string - 告警策略更新时间,时间戳格式。
- Webhook string
- 告警策略绑定的告警回调 URL 地址。
- Webhook
Ids []string - 告警发生时告警回调 ID 列表。
- alert
Methods List<String> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- alert
State String - 告警状态。 alerting:告警中 normal:正常。
- condition
Operator String - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
List<Rule
Condition> - contact
Group List<String>Ids - 告警策略绑定的告警通知组 ID。
- created
At String - 告警策略创建时间,时间戳格式。
- description String
- 告警策略描述信息。
- dimension
Conditions RuleDimension Conditions - Dimension 配置。
- effect
End StringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start StringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State String - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count Integer - 触发告警需要持续的周期。单位为分钟。
- level String
- 告警级别。critical:严重,warning:警告,notice:通知
- level
Conditions List<RuleLevel Condition> - multiple
Conditions Boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace String
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no
Data RuleNo Data - 无数据告警。
- notification
Id String - 通知策略 ID。
- notify
Templates List<RuleNotify Template> - original
Dimensions RuleOriginal Dimensions - 告警策略检测的资源 ID。
- project
Name String - 告警策略所属项目。
- recovery
Notify RuleRecovery Notify - 告警恢复通知。
- regions List<String>
- 云产品所属可用区 ID。
- resource
Type String - 告警策略检测的资源类型。
- rule
Id String - 告警策略 ID。
- rule
Name String - 告警策略名称。
- rule
Type String - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time Integer - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace String - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
-
List<Rule
Tag> - updated
At String - 告警策略更新时间,时间戳格式。
- webhook String
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids List<String> - 告警发生时告警回调 ID 列表。
- alert
Methods string[] - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- alert
State string - 告警状态。 alerting:告警中 normal:正常。
- condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
Rule
Condition[] - contact
Group string[]Ids - 告警策略绑定的告警通知组 ID。
- created
At string - 告警策略创建时间,时间戳格式。
- description string
- 告警策略描述信息。
- dimension
Conditions RuleDimension Conditions - Dimension 配置。
- effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count number - 触发告警需要持续的周期。单位为分钟。
- level string
- 告警级别。critical:严重,warning:警告,notice:通知
- level
Conditions RuleLevel Condition[] - multiple
Conditions boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no
Data RuleNo Data - 无数据告警。
- notification
Id string - 通知策略 ID。
- notify
Templates RuleNotify Template[] - original
Dimensions RuleOriginal Dimensions - 告警策略检测的资源 ID。
- project
Name string - 告警策略所属项目。
- recovery
Notify RuleRecovery Notify - 告警恢复通知。
- regions string[]
- 云产品所属可用区 ID。
- resource
Type string - 告警策略检测的资源类型。
- rule
Id string - 告警策略 ID。
- rule
Name string - 告警策略名称。
- rule
Type string - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time number - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace string - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
-
Rule
Tag[] - updated
At string - 告警策略更新时间,时间戳格式。
- webhook string
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids string[] - 告警发生时告警回调 ID 列表。
- alert_
methods Sequence[str] - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- alert_
state str - 告警状态。 alerting:告警中 normal:正常。
- condition_
operator str - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions
Sequence[Rule
Condition Args] - contact_
group_ Sequence[str]ids - 告警策略绑定的告警通知组 ID。
- created_
at str - 告警策略创建时间,时间戳格式。
- description str
- 告警策略描述信息。
- dimension_
conditions RuleDimension Conditions Args - Dimension 配置。
- effect_
end_ strat - 策略生效的截止时间,格式为HH:MM。
- effect_
start_ strat - 告警策略生效的开始时间,格式为HH:MM。
- enable_
state str - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation_
count int - 触发告警需要持续的周期。单位为分钟。
- level str
- 告警级别。critical:严重,warning:警告,notice:通知
- level_
conditions Sequence[RuleLevel Condition Args] - multiple_
conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace str
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no_
data RuleNo Data Args - 无数据告警。
- notification_
id str - 通知策略 ID。
- notify_
templates Sequence[RuleNotify Template Args] - original_
dimensions RuleOriginal Dimensions Args - 告警策略检测的资源 ID。
- project_
name str - 告警策略所属项目。
- recovery_
notify RuleRecovery Notify Args - 告警恢复通知。
- regions Sequence[str]
- 云产品所属可用区 ID。
- resource_
type str - 告警策略检测的资源类型。
- rule_
id str - 告警策略 ID。
- rule_
name str - 告警策略名称。
- rule_
type str - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence_
time int - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub_
namespace str - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
-
Sequence[Rule
Tag Args] - updated_
at str - 告警策略更新时间,时间戳格式。
- webhook str
- 告警策略绑定的告警回调 URL 地址。
- webhook_
ids Sequence[str] - 告警发生时告警回调 ID 列表。
- alert
Methods List<String> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- alert
State String - 告警状态。 alerting:告警中 normal:正常。
- condition
Operator String - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- conditions List<Property Map>
- contact
Group List<String>Ids - 告警策略绑定的告警通知组 ID。
- created
At String - 告警策略创建时间,时间戳格式。
- description String
- 告警策略描述信息。
- dimension
Conditions Property Map - Dimension 配置。
- effect
End StringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start StringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State String - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count Number - 触发告警需要持续的周期。单位为分钟。
- level String
- 告警级别。critical:严重,warning:警告,notice:通知
- level
Conditions List<Property Map> - multiple
Conditions Boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace String
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no
Data Property Map - 无数据告警。
- notification
Id String - 通知策略 ID。
- notify
Templates List<Property Map> - original
Dimensions Property Map - 告警策略检测的资源 ID。
- project
Name String - 告警策略所属项目。
- recovery
Notify Property Map - 告警恢复通知。
- regions List<String>
- 云产品所属可用区 ID。
- resource
Type String - 告警策略检测的资源类型。
- rule
Id String - 告警策略 ID。
- rule
Name String - 告警策略名称。
- rule
Type String - 告警策略的类型。static:手动选择。dynamic:通过资源名称、项目和标签选择。
- silence
Time Number - 告警发送周期。单位为分钟。支持配置为 5、10、15、30、60、180、360、720、1440。
- sub
Namespace String - 此策略引用的指标所属的维度。详情请参见 云产品监控指标 下各产品的 SubNamespace。
- List<Property Map>
- updated
At String - 告警策略更新时间,时间戳格式。
- webhook String
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids List<String> - 告警发生时告警回调 ID 列表。
Supporting Types
RuleCondition, RuleConditionArgs
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- Metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- Period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- Statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- Threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- Metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- Period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- Statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- Threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator String - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name String - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit String - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period String
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics String
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold String
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison_
operator str - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric_
name str - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric_
unit str - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period str
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics str
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold str
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator String - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name String - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit String - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period String
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics String
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold String
- 指标阈值。支持输入正数或 0。最多支持三位小数。
RuleDimensionConditions, RuleDimensionConditionsArgs
- Meta
Condition Byteplus.Rule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- Project
Condition Byteplus.Rule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- Tag
Condition Byteplus.Rule Dimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- Type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- Meta
Condition RuleDimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- Project
Condition RuleDimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- Tag
Condition RuleDimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- Type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta
Condition RuleDimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project
Condition RuleDimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag
Condition RuleDimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- type String
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta
Condition RuleDimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project
Condition RuleDimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag
Condition RuleDimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta_
condition RuleDimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project_
condition RuleDimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag_
condition RuleDimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- type str
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta
Condition Property Map - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project
Condition Property Map - 根据项目选择告警对象的条件。当Type为project时必填。
- tag
Condition Property Map - 根据标签选择告警对象的条件。当Type为tag时必填。
- type String
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
RuleDimensionConditionsMetaCondition, RuleDimensionConditionsMetaConditionArgs
- All
Dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- Condition string
- 判断条件。and:全部满足。or:任意满足。
- Metas
List<Byteplus.
Rule Dimension Conditions Meta Condition Meta>
- All
Dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- Condition string
- 判断条件。and:全部满足。or:任意满足。
- Metas
[]Rule
Dimension Conditions Meta Condition Meta
- all
Dimensions Boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition String
- 判断条件。and:全部满足。or:任意满足。
- metas
List<Rule
Dimension Conditions Meta Condition Meta>
- all
Dimensions boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition string
- 判断条件。and:全部满足。or:任意满足。
- metas
Rule
Dimension Conditions Meta Condition Meta[]
- all_
dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- condition str
- 判断条件。and:全部满足。or:任意满足。
- metas
Sequence[Rule
Dimension Conditions Meta Condition Meta]
- all
Dimensions Boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition String
- 判断条件。and:全部满足。or:任意满足。
- metas List<Property Map>
RuleDimensionConditionsMetaConditionMeta, RuleDimensionConditionsMetaConditionMetaArgs
- Comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- Key string
- 标签键。
- Values List<string>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- Comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- Key string
- 标签键。
- Values []string
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator String
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key String
- 标签键。
- values List<String>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key string
- 标签键。
- values string[]
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator str
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key str
- 标签键。
- values Sequence[str]
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator String
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key String
- 标签键。
- values List<String>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
RuleDimensionConditionsProjectCondition, RuleDimensionConditionsProjectConditionArgs
- Projects List<string>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- Projects []string
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects List<String>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects string[]
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects Sequence[str]
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects List<String>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
RuleDimensionConditionsTagCondition, RuleDimensionConditionsTagConditionArgs
- Condition string
- 判断条件。and:全部满足。or:任意满足。
-
List<Byteplus.
Rule Dimension Conditions Tag Condition Tag>
- Condition string
- 判断条件。and:全部满足。or:任意满足。
-
[]Rule
Dimension Conditions Tag Condition Tag
- condition String
- 判断条件。and:全部满足。or:任意满足。
-
List<Rule
Dimension Conditions Tag Condition Tag>
- condition string
- 判断条件。and:全部满足。or:任意满足。
-
Rule
Dimension Conditions Tag Condition Tag[]
- condition str
- 判断条件。and:全部满足。or:任意满足。
-
Sequence[Rule
Dimension Conditions Tag Condition Tag]
- condition String
- 判断条件。and:全部满足。or:任意满足。
- List<Property Map>
RuleDimensionConditionsTagConditionTag, RuleDimensionConditionsTagConditionTagArgs
- Comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- Key string
- 标签键。
- Values List<string>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- Comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- Key string
- 标签键。
- Values []string
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator String
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key String
- 标签键。
- values List<String>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator string
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key string
- 标签键。
- values string[]
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator str
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key str
- 标签键。
- values Sequence[str]
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
- comparator String
- 标签匹配时的比较符。contain:包含notcontain:不包含prefixmatch:前缀匹配suffixmatch:后缀匹配equal:等于notequal:不等于exist:存在。
- key String
- 标签键。
- values List<String>
- 标签的值(Value)。当Comparator为exist时,包含 Key 对应的所有 Value,不支持输入。当Comparator为equal或notequal时,支持输入多个 Value。当Comparator为contain、notcontain、prefixmatch或suffixmatch时,仅支持输入 1 个 Value。
RuleLevelCondition, RuleLevelConditionArgs
- Conditions
List<Byteplus.
Rule Level Condition Condition> - Level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- Conditions
[]Rule
Level Condition Condition - Level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
List<Rule
Level Condition Condition> - level String
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
Rule
Level Condition Condition[] - level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
Sequence[Rule
Level Condition Condition] - level str
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions List<Property Map>
- level String
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
RuleLevelConditionCondition, RuleLevelConditionConditionArgs
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- Metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- Period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- Statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- Threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- Metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- Period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- Statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- Threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator String - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name String - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit String - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period String
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics String
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold String
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name string - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit string - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period string
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics string
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold string
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison_
operator str - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric_
name str - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric_
unit str - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period str
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics str
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold str
- 指标阈值。支持输入正数或 0。最多支持三位小数。
- comparison
Operator String - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- metric
Name String - 监控指标的名称。详情请参见 云监控指标查询 下各产品的 MetricName。
- metric
Unit String - 监控指标的单位。详情请参见 云监控指标查询 下各产品的 MetricUnit。说明同环比告警,MetricUnit 需要填写为 "Percent"。MetricUnit 中是否带有 IEC 表示不同的进位:带有 IEC:进位是 1024不带 IEC:进位是 1000。
- period String
- 监控指标的统计周期。详情请参见 云监控指标查询 下各产品的 Period。
- statistics String
- 统计方法,取值:avg:平均值。max:最大值。min:最小值。说明统计方法会应用到检测时间段内的数据上。例如,默认每次检测数据的时间跨度是 1 分钟,如果统计方法为 avg,那就是对 1 分钟内的数据取平均值。
- threshold String
- 指标阈值。支持输入正数或 0。最多支持三位小数。
RuleNoData, RuleNoDataArgs
- Enable bool
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- Evaluation
Count int - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
- Enable bool
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- Evaluation
Count int - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
- enable Boolean
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- evaluation
Count Integer - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
- enable boolean
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- evaluation
Count number - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
- enable bool
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- evaluation_
count int - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
- enable Boolean
- 是否开启无数据告警。取值:true:开启无数据告警。false:(默认)关闭无数据告警。
- evaluation
Count Number - 无数据告警触发阈值,如果在配置的阈值周期内检测无数据上报,则会触发无数据告警。当Enable配置为true时,该字段为必填。整数形式,取值范围为 3~20。
RuleNotifyTemplate, RuleNotifyTemplateArgs
- Channel string
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- Notify
Template stringId - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
- Channel string
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- Notify
Template stringId - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
- channel String
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- notify
Template StringId - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
- channel string
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- notify
Template stringId - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
- channel str
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- notify_
template_ strid - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
- channel String
- 通知渠道,取值:email:邮箱sms:短信phone:电话lark:飞书dingtalk:钉钉wecom:企业微信slack:Slackapi:回调地址。
- notify
Template StringId - 通知模版 ID。注意每种通知渠道仅支持配置 1 个通知模版 ID。
RuleOriginalDimensions, RuleOriginalDimensionsArgs
- Key string
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- Values List<string>
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
- Key string
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- Values []string
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
- key String
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- values List<String>
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
- key string
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- values string[]
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
- key str
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- values Sequence[str]
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
- key String
- 指标 Dimension 名称,例如ResourceID、NodeName等。不同云产品的 Dimensions 名称不同,详情请参见 云监控指标查询。ResourceID为必填项,且大小写必须与 云监控指标查询 中的一致。支持同时填写多个 Dimension 名称,并基于多个 Dimension 名称进行分组。举例如下:当您仅填写ResourceID时,系统会按照ResourceID进行告警分组。当您同时填写ResourceID和NodeName时,系统会首先按照ResourceID进行告警分组。然后在每个分组内,再按照NodeName进行分组。
- values List<String>
- 指标 Dimension 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
RuleRecoveryNotify, RuleRecoveryNotifyArgs
- Enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- Enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable Boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable Boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
RuleTag, RuleTagArgs
Import
$ pulumi import bytepluscc:cloudmonitor/rule:Rule example "rule_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
