アラートルールの作成 (V2)

Creates a new alert rule in the specified project. The current user should be a project admin.

POST/v2/alertRules

接続エンドポイント

https://api.cloud.zilliz.com

shell

export BASE_URL="https://api.cloud.zilliz.com"

パラメータ

Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}

Acceptstringheader

application/json を使用します。

値の例： application/json

リクエスト・ボディapplication/json

projectIdstring必要

アラートルールが属するプロジェクトの ID。

ruleNamestring必要

アラートルールの名前。

levelstring必要

アラートルールのレベル。

可能な値：

CRITICAL WARNING

metricNamestring必要

アラートルールが監視するメトリクスの名前。

thresholdstring

アラートルールのしきい値。

windowSizestring

アラートルールの時間ウィンドウ（分）。

enabledboolean必要

アラートルールが有効かどうかを示します。

sendResolvedboolean必要

アラートルールが解決されたときに通知を送信するかどうかを示します。

actionsarray必要

アラートルールがトリガーされたときに実行するアクション。

[]actionsobject必要

アラートルールがトリガーされたときに実行するアクション。

typestring必要

アクションのタイプ。

可能な値：

EMAIL SMS WEBHOOK SLACK LARK WECOM PAGERDUTY OPSGENIE

configobject必要

アクションの設定。

recipientsobject

アラート通知の受信者。これは、アクションタイプが EMAIL および SMS の場合にのみ適用されます。

membersarray

アラート通知を受信するメールアドレスの一覧。

[]membersstring

アラート通知を受信するメールアドレス。

orgRolesarray

アラート通知を受信する組織ロールの一覧。

[]orgRolesstring

アラート通知を受信する組織ロール。

可能な値：

OWNER MEMBER BILLING_ADMIN

projectRolesarray

アラート通知を受信するプロジェクトロールの一覧。

[]projectRolesstring

アラート通知を受信するプロジェクトロール。

可能な値：

OWNER MEMBER

urlstring

アラート通知の送信先 URL。これは、アクションタイプが WEBHOOK の場合にのみ適用されます。

webhookUrlstring

アラート通知の送信先 URL。これは、アクションタイプが SLACK、LARK、および WECOM の場合にのみ適用されます。

regionstring

PagerDuty または OpsGenie サービスが配置されているリージョン。これは、アクションタイプが PAGERDUTY および OPSGENIE の場合にのみ適用されます。

apiKeystring

PagerDuty または OpsGenie サービスの API key。これは、アクションタイプが PAGERDUTY および OPSGENIE の場合にのみ適用されます。

comparisonMethodstring

アラートルールで使用される比較演算子。

可能な値：

GREATER_THAN EQUALS LESS_THAN GREATER_THAN_OR_EQUALS LESS_THAN_OR_EQUALS

targetInstanceIdsarray

アラートルールが適用されるクラスターの ID。

[]targetInstanceIdsstring

クラスターの ID。

metricUnitstring

メトリクスの単位（例: "bytes"、"percent"）。

repeatIntervalSecondsinteger

アラート通知を繰り返し送信する間隔（秒）。

bash

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/alertRules" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "id": "12391290837zs09sad0d09123",
    "projectId": "proj-b44a39b0c51cf21791a841",
    "ruleName": "my alert name",
    "level": "CRITICAL",
    "metricName": "REQUEST_LATENCY_SEARCH_P99",
    "threshold": "70",
    "windowSize": "10",
    "targetClusterIds": [
        "in01-xxxxxxxxxxxx"
    ],
    "enabled": true,
    "sendResolved": true,
    "actions": [
        {
            "type": "EMAIL",
            "config": {
                "recipients": {
                    "members": [
                        "your-email@your-org.com"
                    ],
                    "orgRoles": [
                        "OWNER",
                        "MEMBER",
                        "BILLING_ADMIN"
                    ],
                    "projectRoles": [
                        "OWNER",
                        "MEMBER"
                    ]
                }
            }
        },
        {
            "type": "SMS",
            "config": {
                "recipients": {
                    "members": [
                        "your-email@your-org.com"
                    ],
                    "orgRoles": [
                        "OWNER",
                        "MEMBER",
                        "BILLING_ADMIN"
                    ],
                    "projectRoles": [
                        "OWNER",
                        "MEMBER"
                    ]
                }
            }
        },
        {
            "type": "WEBHOOK",
            "config": {
                "url": "https://xxxx"
            }
        },
        {
            "type": "SLACK",
            "config": {
                "webhookUrl": "https://xxxx"
            }
        },
        {
            "type": "LARK",
            "config": {
                "webhookUrl": "https://xxxx"
            }
        },
        {
            "type": "WECOM",
            "config": {
                "webhookUrl": "https://xxxx"
            }
        },
        {
            "type": "PAGERDUTY",
            "config": {
                "region": "US",
                "apiKey": "..."
            }
        },
        {
            "type": "OPSGENIE",
            "config": {
                "region": "US",
                "apiKey": "..."
            }
        }
    ],
    "comparisonMethod": "GREATER_THAN"
}'

レスポンス200 OK - application/json

指定したプロジェクト内のアラートルールの一覧を返します。

Success

アラートルールの一覧を返します。

codeinteger

レスポンスコード。

dataobject

idstring

アラートルールの ID。

projectIdstring

アラートルールが属するプロジェクトの ID。

ruleNamestring

アラートルールの名前。

levelstring

アラートルールのレベル。

可能な値：

CRITICAL WARNING

metricNamestring

アラートルールが監視するメトリクスの名前。

thresholdstring

アラートルールのしきい値。

windowSizestring

アラートルールの時間ウィンドウ（分）。

enabledboolean

アラートルールが有効かどうかを示します。

sendResolvedboolean

アラートルールが解決されたときに通知を送信するかどうかを示します。

actionsarray

アラートルールがトリガーされたときに実行するアクション。

[]actionsobject

アラートルールがトリガーされたときに実行するアクション。

typestring

アクションのタイプ。

可能な値：

EMAIL SMS WEBHOOK SLACK LARK WECOM PAGERDUTY OPSGENIE

configobject

アクションの設定。

recipientsobject

アラート通知の受信者。これは、アクションタイプが EMAIL および SMS の場合にのみ適用されます。

membersarray

アラート通知を受信するメールアドレスの一覧。

[]membersstring

アラート通知を受信するメールアドレス。

orgRolesarray

アラート通知を受信する組織ロールの一覧。

[]orgRolesstring

アラート通知を受信する組織ロール。

可能な値：

OWNER MEMBER BILLING_ADMIN

projectRolesarray

アラート通知を受信するプロジェクトロールの一覧。

[]projectRolesstring

アラート通知を受信するプロジェクトロール。

可能な値：

OWNER MEMBER

urlstring

アラート通知の送信先 URL。これは、アクションタイプが WEBHOOK の場合にのみ適用されます。

webhookUrlstring

アラート通知の送信先 URL。これは、アクションタイプが SLACK、LARK、および WECOM の場合にのみ適用されます。

regionstring

PagerDuty または OpsGenie サービスが配置されているリージョン。これは、アクションタイプが PAGERDUTY および OPSGENIE の場合にのみ適用されます。

apiKeystring

PagerDuty または OpsGenie サービスの API key。これは、アクションタイプが PAGERDUTY および OPSGENIE の場合にのみ適用されます。

comparisonMethodstring

アラートルールで使用される比較演算子。

可能な値：

GREATER_THAN EQUALS LESS_THAN GREATER_THAN_OR_EQUALS LESS_THAN_OR_EQUALS

targetInstanceIdsarray

アラートルールが適用されるクラスターの ID。

[]targetInstanceIdsstring

クラスターの ID。

Error

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson

{
    "code": 0,
    "data": {
        "id": "12391290837zs09sad0d09123",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "ruleName": "my alert name",
        "level": "CRITICAL",
        "metricName": "REQUEST_LATENCY_SEARCH_P99",
        "threshold": "70",
        "windowSize": "10",
        "enabled": true,
        "sendResolved": true,
        "actions": [
            {
                "type": "EMAIL",
                "config": {
                    "recipients": {
                        "members": [
                            "your-email@your-org.com"
                        ],
                        "orgRoles": [
                            "OWNER",
                            "MEMBER",
                            "BILLING_ADMIN"
                        ],
                        "projectRoles": [
                            "OWNER",
                            "MEMBER"
                        ]
                    }
                }
            },
            {
                "type": "SMS",
                "config": {
                    "recipients": {
                        "members": [
                            "your-email@your-org.com"
                        ],
                        "orgRoles": [
                            "OWNER",
                            "MEMBER",
                            "BILLING_ADMIN"
                        ],
                        "projectRoles": [
                            "OWNER",
                            "MEMBER"
                        ]
                    }
                }
            },
            {
                "type": "WEBHOOK",
                "config": {
                    "url": "https://xxxx"
                }
            },
            {
                "type": "SLACK",
                "config": {
                    "webhookUrl": "https://xxxx"
                }
            },
            {
                "type": "LARK",
                "config": {
                    "webhookUrl": "https://xxxx"
                }
            },
            {
                "type": "WECOM",
                "config": {
                    "webhookUrl": "https://xxxx"
                }
            },
            {
                "type": "PAGERDUTY",
                "config": {
                    "region": "US",
                    "apiKey": "..."
                }
            },
            {
                "type": "OPSGENIE",
                "config": {
                    "region": "US",
                    "apiKey": "..."
                }
            }
        ],
        "comparisonMethod": "GREATER_THAN",
        "targetInstanceIds": [
            "in01-xxxxxxxxxxxx"
        ]
    }
}