Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Data Source schema for Byteplus::CloudMonitor::Rule
Using getRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>def get_rule(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput> Note: This function is named LookupRule in the Go SDK.
public static class GetRule
{
public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
fn::invoke:
function: bytepluscc:cloudmonitor/getRule:getRule
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Uniquely identifies the resource.
- Id string
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
- id string
- Uniquely identifies the resource.
- id str
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
getRule Result
The following output properties are available:
- Alert
Methods List<string> - 告警通知的方式。Email:邮件 Phone:电话 SMS:短信 Webhook:告警回调。
- Alert
State string - 告警状态。 alerting:告警中 normal:正常。
- Condition
Operator string - 多指标判定条件。&&:多个指标同时成立才判定为触发告警,||:任意指标满足条件触发判定为告警。
- Conditions
List<Byteplus.
Get Rule Condition> - 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- Contact
Group List<string>Ids - 告警策略绑定的告警通知组 ID。
- Created
At string - 告警策略创建时间,时间戳格式。
- Description string
- 告警策略描述信息。
- Dimension
Conditions Byteplus.Get Rule Dimension Conditions - Dimension 配置。
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Id string
- Uniquely identifies the resource.
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Level
Conditions List<Byteplus.Get Rule Level Condition> - 告警分级配置。
- Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- No
Data Byteplus.Get Rule No Data - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates List<Byteplus.Get Rule Notify Template> - 通知模版配置。
- Original
Dimensions Byteplus.Get Rule Original Dimensions - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify Byteplus.Get 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.
Get Rule Tag> - 告警策略绑定 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
[]Get
Rule Condition - 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- Contact
Group []stringIds - 告警策略绑定的告警通知组 ID。
- Created
At string - 告警策略创建时间,时间戳格式。
- Description string
- 告警策略描述信息。
- Dimension
Conditions GetRule Dimension Conditions - Dimension 配置。
- Effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- Effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- Enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- Evaluation
Count int - 触发告警需要持续的周期。单位为分钟。
- Id string
- Uniquely identifies the resource.
- Level string
- 告警级别。critical:严重,warning:警告,notice:通知
- Level
Conditions []GetRule Level Condition - 告警分级配置。
- Multiple
Conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- Namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- No
Data GetRule No Data - 无数据告警。
- Notification
Id string - 通知策略 ID。
- Notify
Templates []GetRule Notify Template - 通知模版配置。
- Original
Dimensions GetRule Original Dimensions - 告警策略检测的资源 ID。
- Project
Name string - 告警策略所属项目。
- Recovery
Notify GetRule Recovery Notify - 告警恢复通知。
- 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。
-
[]Get
Rule Tag - 告警策略绑定 Tag。
- 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<Get
Rule Condition> - 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- contact
Group List<String>Ids - 告警策略绑定的告警通知组 ID。
- created
At String - 告警策略创建时间,时间戳格式。
- description String
- 告警策略描述信息。
- dimension
Conditions GetRule Dimension Conditions - Dimension 配置。
- effect
End StringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start StringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State String - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count Integer - 触发告警需要持续的周期。单位为分钟。
- id String
- Uniquely identifies the resource.
- level String
- 告警级别。critical:严重,warning:警告,notice:通知
- level
Conditions List<GetRule Level Condition> - 告警分级配置。
- multiple
Conditions Boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace String
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no
Data GetRule No Data - 无数据告警。
- notification
Id String - 通知策略 ID。
- notify
Templates List<GetRule Notify Template> - 通知模版配置。
- original
Dimensions GetRule Original Dimensions - 告警策略检测的资源 ID。
- project
Name String - 告警策略所属项目。
- recovery
Notify GetRule Recovery 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<Get
Rule Tag> - 告警策略绑定 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
Get
Rule Condition[] - 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- contact
Group string[]Ids - 告警策略绑定的告警通知组 ID。
- created
At string - 告警策略创建时间,时间戳格式。
- description string
- 告警策略描述信息。
- dimension
Conditions GetRule Dimension Conditions - Dimension 配置。
- effect
End stringAt - 策略生效的截止时间,格式为HH:MM。
- effect
Start stringAt - 告警策略生效的开始时间,格式为HH:MM。
- enable
State string - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation
Count number - 触发告警需要持续的周期。单位为分钟。
- id string
- Uniquely identifies the resource.
- level string
- 告警级别。critical:严重,warning:警告,notice:通知
- level
Conditions GetRule Level Condition[] - 告警分级配置。
- multiple
Conditions boolean - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace string
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no
Data GetRule No Data - 无数据告警。
- notification
Id string - 通知策略 ID。
- notify
Templates GetRule Notify Template[] - 通知模版配置。
- original
Dimensions GetRule Original Dimensions - 告警策略检测的资源 ID。
- project
Name string - 告警策略所属项目。
- recovery
Notify GetRule Recovery 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。
-
Get
Rule Tag[] - 告警策略绑定 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[Get
Rule Condition] - 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- contact_
group_ Sequence[str]ids - 告警策略绑定的告警通知组 ID。
- created_
at str - 告警策略创建时间,时间戳格式。
- description str
- 告警策略描述信息。
- dimension_
conditions GetRule Dimension Conditions - Dimension 配置。
- effect_
end_ strat - 策略生效的截止时间,格式为HH:MM。
- effect_
start_ strat - 告警策略生效的开始时间,格式为HH:MM。
- enable_
state str - 告警策略的开启状态。,enable:开启,disable:禁用
- evaluation_
count int - 触发告警需要持续的周期。单位为分钟。
- id str
- Uniquely identifies the resource.
- level str
- 告警级别。critical:严重,warning:警告,notice:通知
- level_
conditions Sequence[GetRule Level Condition] - 告警分级配置。
- multiple_
conditions bool - 告警策略是否用多指标。true:多指标,false:单指标(默认)。
- namespace str
- 监控指标所属的云产品。详情请参见 云产品监控指标 下各产品的 Namespace。
- no_
data GetRule No Data - 无数据告警。
- notification_
id str - 通知策略 ID。
- notify_
templates Sequence[GetRule Notify Template] - 通知模版配置。
- original_
dimensions GetRule Original Dimensions - 告警策略检测的资源 ID。
- project_
name str - 告警策略所属项目。
- recovery_
notify GetRule Recovery Notify - 告警恢复通知。
- 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[Get
Rule Tag] - 告警策略绑定 Tag。
- 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>
- 告警条件。数组形式,支持填写多个指标判断语句,最多 10 个。
- 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 - 触发告警需要持续的周期。单位为分钟。
- id String
- Uniquely identifies the resource.
- 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>
- 告警策略绑定 Tag。
- updated
At String - 告警策略更新时间,时间戳格式。
- webhook String
- 告警策略绑定的告警回调 URL 地址。
- webhook
Ids List<String> - 告警发生时告警回调 ID 列表。
Supporting Types
GetRuleCondition
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- Display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name String - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display_
name str - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name String - 指标显示名称。
- 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。最多支持三位小数。
GetRuleDimensionConditions
- Meta
Condition Byteplus.Get Rule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- Project
Condition Byteplus.Get Rule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- Tag
Condition Byteplus.Get Rule Dimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- Type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- Meta
Condition GetRule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- Project
Condition GetRule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- Tag
Condition GetRule Dimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- Type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta
Condition GetRule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project
Condition GetRule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag
Condition GetRule Dimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- type String
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta
Condition GetRule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project
Condition GetRule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag
Condition GetRule Dimension Conditions Tag Condition - 根据标签选择告警对象的条件。当Type为tag时必填。
- type string
- Dimensions 类型。取值:project:根据项目选择告警对象。tag:根据标签选择告警对象。meta:根据资源名称选择告警对象。
- meta_
condition GetRule Dimension Conditions Meta Condition - 根据资源名称选择告警对象的条件。当Type为meta时必填。
- project_
condition GetRule Dimension Conditions Project Condition - 根据项目选择告警对象的条件。当Type为project时必填。
- tag_
condition GetRule Dimension 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:根据资源名称选择告警对象。
GetRuleDimensionConditionsMetaCondition
- All
Dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- Condition string
- 判断条件。and:全部满足。or:任意满足。
- Metas
List<Byteplus.
Get Rule Dimension Conditions Meta Condition Meta> - 判断条件。and:全部满足。or:任意满足。
- All
Dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- Condition string
- 判断条件。and:全部满足。or:任意满足。
- Metas
[]Get
Rule Dimension Conditions Meta Condition Meta - 判断条件。and:全部满足。or:任意满足。
- all
Dimensions Boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition String
- 判断条件。and:全部满足。or:任意满足。
- metas
List<Get
Rule Dimension Conditions Meta Condition Meta> - 判断条件。and:全部满足。or:任意满足。
- all
Dimensions boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition string
- 判断条件。and:全部满足。or:任意满足。
- metas
Get
Rule Dimension Conditions Meta Condition Meta[] - 判断条件。and:全部满足。or:任意满足。
- all_
dimensions bool - 是否为全量资源。true:全部资源。false:部分资源。
- condition str
- 判断条件。and:全部满足。or:任意满足。
- metas
Sequence[Get
Rule Dimension Conditions Meta Condition Meta] - 判断条件。and:全部满足。or:任意满足。
- all
Dimensions Boolean - 是否为全量资源。true:全部资源。false:部分资源。
- condition String
- 判断条件。and:全部满足。or:任意满足。
- metas List<Property Map>
- 判断条件。and:全部满足。or:任意满足。
GetRuleDimensionConditionsMetaConditionMeta
- 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。
GetRuleDimensionConditionsProjectCondition
- Projects List<string>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- Projects []string
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects List<String>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects string[]
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects Sequence[str]
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
- projects List<String>
- 项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。
GetRuleDimensionConditionsTagCondition
- Condition string
- 判断条件。and:全部满足。or:任意满足。
-
List<Byteplus.
Get Rule Dimension Conditions Tag Condition Tag> - 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
- Condition string
- 判断条件。and:全部满足。or:任意满足。
-
[]Get
Rule Dimension Conditions Tag Condition Tag - 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
- condition String
- 判断条件。and:全部满足。or:任意满足。
-
List<Get
Rule Dimension Conditions Tag Condition Tag> - 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
- condition string
- 判断条件。and:全部满足。or:任意满足。
-
Get
Rule Dimension Conditions Tag Condition Tag[] - 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
- condition str
- 判断条件。and:全部满足。or:任意满足。
-
Sequence[Get
Rule Dimension Conditions Tag Condition Tag] - 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
- condition String
- 判断条件。and:全部满足。or:任意满足。
- List<Property Map>
- 标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
GetRuleDimensionConditionsTagConditionTag
- 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。
GetRuleLevelCondition
- Conditions
List<Byteplus.
Get Rule Level Condition Condition> - 告警分级配置。
- Level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- Conditions
[]Get
Rule Level Condition Condition - 告警分级配置。
- Level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
List<Get
Rule Level Condition Condition> - 告警分级配置。
- level String
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
Get
Rule Level Condition Condition[] - 告警分级配置。
- level string
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions
Sequence[Get
Rule Level Condition Condition] - 告警分级配置。
- level str
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
- conditions List<Property Map>
- 告警分级配置。
- level String
- 告警通知等级,取值:notice:通知warning:警告critical:严重recovery:恢复。
GetRuleLevelConditionCondition
- Comparison
Operator string - 比较符号。支持普通阈值告警: >、>=、<、<=、!=、= ,以及以下同环比告警:lastperiodincreasepct:环比上周期上涨。lastperioddecreasepct:环比上周起下降。lastperiodabspct:环比上周期上涨或下降。lastdayincreasepct:同比昨天同一时段上涨。lastdaydecreasepct:同比昨天同一时段下降。lastdayabspct:同比昨天同一时段上涨或下降。lastweekincreasepct:同比上周同一时段上涨。lastweekdecreasepct:同比上周同一时段下降。lastweekabs_pct:同比上周同一时段上涨或下降。
- Display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- Display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name String - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name string - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display_
name str - 指标显示名称。
- 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:同比上周同一时段上涨或下降。
- display
Name String - 指标显示名称。
- 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。最多支持三位小数。
GetRuleNoData
- 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。
GetRuleNotifyTemplate
- 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。
GetRuleOriginalDimensions
- 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 值,数组形式。多个值之间使用英文半角逗号,分割。允许使用通配符选择全部实例的值。例如:[""] 。
GetRuleRecoveryNotify
- Enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- Enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable Boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable bool
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
- enable Boolean
- 是否开启告警恢复通知。取值:true:(默认)开启告警恢复通知。false:关闭告警恢复通知。
GetRuleTag
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
