新建 - cloudpods

新建

请求参数

Body 参数application/json

count

integer <int64>

可选

默认值:

node_alert

object (NodeAlertCreateInput)

可选

channel

string

可选

通知方式, 比如: email, mobile

common_alert_create_input

object (CommonAlertCreateInput)

可选

comparator

string

可选

比较运算符, 比如: >, <, >=, <=

customize_config

object

可选

customize info

enabled

boolean

启用报警

可选

execution_error_state

string

可选

报警执行错误将当前报警状态设置为对应的状态

for

integer <int64>

报警持续时间

可选

frequency

integer <int64>

报警执行频率

可选

level

string

报警级别

可选

metric

string

监控指标名称

可选

name

string

报警名称

可选

no_data_state

string

可选

没有收到监控指标时将当前报警状态设置为对应的状态

node_id

string

监控资源 Id

可选

node_name

string

监控资源名称

可选

period

string

查询指标周期

可选

recipients

string

通知接受者

可选

settings

object (AlertSetting)

可选

AlertSettings contains alert conditions

threshold

number <double>

报警阀值

可选

type

string

可选

监控资源类型, 比如: guest, host

used_by

string

可选

window

string

每隔多久查询一次

可选

示例

{
    "count": 1,
    "node_alert": {
        "channel": "string",
        "common_alert_create_input": {
            "alert_duration": 0,
            "alert_type": "string",
            "channel": [
                "string"
            ],
            "customize_config": {},
            "description": "string",
            "domain_id": "string",
            "enabled": true,
            "execution_error_state": "string",
            "for": 0,
            "frequency": 0,
            "from": "string",
            "get_point_str": true,
            "interval": "string",
            "level": "string",
            "meta_name": "string",
            "metric_query": [
                {
                    "comparator": "string",
                    "condition_type": "string",
                    "data_source_id": "string",
                    "field_opt": "string",
                    "from": "string",
                    "model": {
                        "alias": "string",
                        "database": "string",
                        "group_by": [
                            {
                                "params": [
                                    "string"
                                ],
                                "type": "string"
                            }
                        ],
                        "interval": "string",
                        "measurement": "string",
                        "policy": "string",
                        "result_format": "string",
                        "select": [
                            [
                                {
                                    "params": [
                                        "string"
                                    ],
                                    "type": "string"
                                }
                            ]
                        ],
                        "tags": [
                            {
                                "condition": "string",
                                "key": "string",
                                "operator": "string",
                                "value": "string"
                            }
                        ],
                        "tz": "string"
                    },
                    "reduce": "string",
                    "threshold": 0,
                    "to": "string"
                }
            ],
            "name": "string",
            "no_data_state": "string",
            "period": "string",
            "project_id": "string",
            "recipients": [
                "string"
            ],
            "robot_ids": [
                "string"
            ],
            "roles": [
                "string"
            ],
            "scope": "string",
            "settings": {
                "conditions": [
                    {
                        "evaluator": {
                            "operators": [
                                "string"
                            ],
                            "params": [
                                0
                            ],
                            "type": "string"
                        },
                        "operator": "string",
                        "query": {
                            "data_source_id": "string",
                            "from": "string",
                            "model": {
                                "alias": "string",
                                "database": "string",
                                "group_by": [
                                    {
                                        "params": [
                                            "string"
                                        ],
                                        "type": "string"
                                    }
                                ],
                                "interval": "string",
                                "measurement": "string",
                                "policy": "string",
                                "result_format": "string",
                                "select": [
                                    [
                                        {
                                            "params": [
                                                "string"
                                            ],
                                            "type": "string"
                                        }
                                    ]
                                ],
                                "tags": [
                                    {
                                        "condition": "string",
                                        "key": "string",
                                        "operator": "string",
                                        "value": "string"
                                    }
                                ],
                                "tz": "string"
                            },
                            "to": "string"
                        },
                        "reducer": {
                            "operators": [
                                "string"
                            ],
                            "params": [
                                0
                            ],
                            "type": "string"
                        },
                        "type": "string"
                    }
                ]
            },
            "silent_period": "string",
            "to": "string",
            "used_by": "string"
        },
        "comparator": "string",
        "customize_config": {},
        "enabled": true,
        "execution_error_state": "string",
        "for": 0,
        "frequency": 0,
        "level": "string",
        "metric": "string",
        "name": "string",
        "no_data_state": "string",
        "node_id": "string",
        "node_name": "string",
        "period": "string",
        "recipients": "string",
        "settings": {
            "conditions": [
                {
                    "evaluator": {
                        "operators": [
                            "string"
                        ],
                        "params": [
                            0
                        ],
                        "type": "string"
                    },
                    "operator": "string",
                    "query": {
                        "data_source_id": "string",
                        "from": "string",
                        "model": {
                            "alias": "string",
                            "database": "string",
                            "group_by": [
                                {
                                    "params": [
                                        "string"
                                    ],
                                    "type": "string"
                                }
                            ],
                            "interval": "string",
                            "measurement": "string",
                            "policy": "string",
                            "result_format": "string",
                            "select": [
                                [
                                    {
                                        "params": [
                                            "string"
                                        ],
                                        "type": "string"
                                    }
                                ]
                            ],
                            "tags": [
                                {
                                    "condition": "string",
                                    "key": "string",
                                    "operator": "string",
                                    "value": "string"
                                }
                            ],
                            "tz": "string"
                        },
                        "to": "string"
                    },
                    "reducer": {
                        "operators": [
                            "string"
                        ],
                        "params": [
                            0
                        ],
                        "type": "string"
                    },
                    "type": "string"
                }
            ]
        },
        "threshold": 0,
        "type": "string",
        "used_by": "string",
        "window": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/node_alerts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "count": 1,
    "node_alert": {
        "channel": "string",
        "common_alert_create_input": {
            "alert_duration": 0,
            "alert_type": "string",
            "channel": [
                "string"
            ],
            "customize_config": {},
            "description": "string",
            "domain_id": "string",
            "enabled": true,
            "execution_error_state": "string",
            "for": 0,
            "frequency": 0,
            "from": "string",
            "get_point_str": true,
            "interval": "string",
            "level": "string",
            "meta_name": "string",
            "metric_query": [
                {
                    "comparator": "string",
                    "condition_type": "string",
                    "data_source_id": "string",
                    "field_opt": "string",
                    "from": "string",
                    "model": {
                        "alias": "string",
                        "database": "string",
                        "group_by": [
                            {
                                "params": [
                                    "string"
                                ],
                                "type": "string"
                            }
                        ],
                        "interval": "string",
                        "measurement": "string",
                        "policy": "string",
                        "result_format": "string",
                        "select": [
                            [
                                {
                                    "params": [
                                        "string"
                                    ],
                                    "type": "string"
                                }
                            ]
                        ],
                        "tags": [
                            {
                                "condition": "string",
                                "key": "string",
                                "operator": "string",
                                "value": "string"
                            }
                        ],
                        "tz": "string"
                    },
                    "reduce": "string",
                    "threshold": 0,
                    "to": "string"
                }
            ],
            "name": "string",
            "no_data_state": "string",
            "period": "string",
            "project_id": "string",
            "recipients": [
                "string"
            ],
            "robot_ids": [
                "string"
            ],
            "roles": [
                "string"
            ],
            "scope": "string",
            "settings": {
                "conditions": [
                    {
                        "evaluator": {
                            "operators": [
                                "string"
                            ],
                            "params": [
                                0
                            ],
                            "type": "string"
                        },
                        "operator": "string",
                        "query": {
                            "data_source_id": "string",
                            "from": "string",
                            "model": {
                                "alias": "string",
                                "database": "string",
                                "group_by": [
                                    {
                                        "params": [
                                            "string"
                                        ],
                                        "type": "string"
                                    }
                                ],
                                "interval": "string",
                                "measurement": "string",
                                "policy": "string",
                                "result_format": "string",
                                "select": [
                                    [
                                        {
                                            "params": [
                                                "string"
                                            ],
                                            "type": "string"
                                        }
                                    ]
                                ],
                                "tags": [
                                    {
                                        "condition": "string",
                                        "key": "string",
                                        "operator": "string",
                                        "value": "string"
                                    }
                                ],
                                "tz": "string"
                            },
                            "to": "string"
                        },
                        "reducer": {
                            "operators": [
                                "string"
                            ],
                            "params": [
                                0
                            ],
                            "type": "string"
                        },
                        "type": "string"
                    }
                ]
            },
            "silent_period": "string",
            "to": "string",
            "used_by": "string"
        },
        "comparator": "string",
        "customize_config": {},
        "enabled": true,
        "execution_error_state": "string",
        "for": 0,
        "frequency": 0,
        "level": "string",
        "metric": "string",
        "name": "string",
        "no_data_state": "string",
        "node_id": "string",
        "node_name": "string",
        "period": "string",
        "recipients": "string",
        "settings": {
            "conditions": [
                {
                    "evaluator": {
                        "operators": [
                            "string"
                        ],
                        "params": [
                            0
                        ],
                        "type": "string"
                    },
                    "operator": "string",
                    "query": {
                        "data_source_id": "string",
                        "from": "string",
                        "model": {
                            "alias": "string",
                            "database": "string",
                            "group_by": [
                                {
                                    "params": [
                                        "string"
                                    ],
                                    "type": "string"
                                }
                            ],
                            "interval": "string",
                            "measurement": "string",
                            "policy": "string",
                            "result_format": "string",
                            "select": [
                                [
                                    {
                                        "params": [
                                            "string"
                                        ],
                                        "type": "string"
                                    }
                                ]
                            ],
                            "tags": [
                                {
                                    "condition": "string",
                                    "key": "string",
                                    "operator": "string",
                                    "value": "string"
                                }
                            ],
                            "tz": "string"
                        },
                        "to": "string"
                    },
                    "reducer": {
                        "operators": [
                            "string"
                        ],
                        "params": [
                            0
                        ],
                        "type": "string"
                    },
                    "type": "string"
                }
            ]
        },
        "threshold": 0,
        "type": "string",
        "used_by": "string",
        "window": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

node_alert

object (NodeAlertDetails)

可选

can_delete

boolean

可选

资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因

示例值:

true

can_update

boolean

可选

资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因

示例值:

true

channel

string

可选

comparator

string

可选

created_at

string <date-time>

资源创建时间

可选

customize_config

object

可选

string

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

domain_id

string

域Id

可选

enabled

boolean

资源是否启用

可选

eval_data

object

可选

execution_error

string

可选

Silenced bool

execution_error_state

string

可选

field

string

可选

for

integer <int64>

可选

If an alert rule has a configured For and the query violates the configured threshold
it will first go from OK to Pending. Going from OK to Pending will not send any
notifications. Once the alert rule has been firing for more than For duration, it will
change to Alerting and send alert notifications.

frequency

integer <int64>

可选

Frequency is evaluate period

string

资源UUID

可选

is_emulated

boolean

可选

是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数

last_state_change

string <date-time>

可选

level

string

可选

measurement

string

可选

message

string

可选

metadata

object

标签

可选

metric

string

可选

name

string

资源名称

可选

no_data_state

string

可选

node_id

string

可选

node_name

string

可选

notifier_id

string

可选

period

string

可选

progress

number <float>

操作进度0-100

可选

project

string

可选

资源归属项目的名称（向后兼容别名）
Deprecated

project_domain

string

可选

资源归属项目的域名称

project_id

string

可选

资源归属项目的ID(向后兼容别名）
Deprecated

recipients

string

可选

res_type

string

可选

scope

string

可选

settings

object

可选

state

string

可选

state_changes

integer <int64>

可选

status

string

资源状态

可选

tenant

string

可选

资源归属项目的名称
alias:project

tenant_id

string

项目Id

可选

threshold

number <double>

可选

type

string

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

used_by

string

可选

window

string

可选

示例

{
    "node_alert": {
        "can_delete": true,
        "can_update": true,
        "channel": "string",
        "comparator": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "customize_config": {},
        "db": "string",
        "delete_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "deleted": true,
        "deleted_at": "2019-08-24T14:15:22Z",
        "description": "string",
        "domain_id": "string",
        "enabled": true,
        "eval_data": {},
        "execution_error": "string",
        "execution_error_state": "string",
        "field": "string",
        "for": 0,
        "frequency": 0,
        "id": "string",
        "is_emulated": true,
        "last_state_change": "2019-08-24T14:15:22Z",
        "level": "string",
        "measurement": "string",
        "message": "string",
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "metric": "string",
        "name": "string",
        "no_data_state": "string",
        "node_id": "string",
        "node_name": "string",
        "notifier_id": "string",
        "period": "string",
        "progress": 0,
        "project": "string",
        "project_domain": "string",
        "project_id": "string",
        "recipients": "string",
        "res_type": "string",
        "scope": "string",
        "settings": {},
        "state": "string",
        "state_changes": 0,
        "status": "string",
        "tenant": "string",
        "tenant_id": "string",
        "threshold": 0,
        "type": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "used_by": "string",
        "window": "string"
    }
}