メインコンテンツまでスキップ

アラートルールを一覧表示 (V2)

Lists all alert rules in the specified project. The current user should be a project admin.

GET/v2/alertRules
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}
projectIdstringquery必要

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

値の例： proj-xxxxxxxxxxxxxxxxxxxxxx
pageSizeintegerquery

各ページで返される項目数。

値の例： 10
currentPageintegerquery

返されるページ番号。

値の例： 1
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/alertRules?projectId=proj-xxxxxxxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

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

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

codeinteger

レスポンスコード。

dataobject
countinteger

アラートルールの総数。

currentPageinteger

現在のページ番号。

pageSizeinteger

各ページのレコード数。

alertRulesarray

アラートルールの一覧。

[]alertRulesobject
idstring

アラートルールの ID。

projectIdstring

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

ruleNamestring

アラートルールの名前。

levelstring

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

metricNamestring

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

thresholdstring

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

windowSizestring

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

enabledboolean

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

sendResolvedboolean

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

actionsarray

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

[]actionsobject

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

typestring

アクションのタイプ。

configobject

アクションの設定。

recipientsobject

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

membersarray

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

[]membersstring

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

orgRolesarray

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

[]orgRolesstring

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

projectRolesarray

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

[]projectRolesstring

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

urlstring

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

webhookUrlstring

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

regionstring

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

apiKeystring

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

comparisonMethodstring

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

targetInstanceIdsarray

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

[]targetInstanceIdsstring

クラスターの ID。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "alertRules": [
            {
                "id": "12391290837zs09sad0d09123",
                "projectId": "proj-b44a39b0c51cf21791a841",
                "ruleName": "my alert name",
                "level": "CRITICAL|WARNING",
                "metricName": "REQUEST_LATENCY_SEARCH_P99",
                "threshold": "70",
                "windowSize": "10",
                "comparisonMethod": "GREATER_THAN",
                "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": "..."
                        }
                    }
                ],
                "targetInstanceIds": [
                    "in01-xxxxxxxxxxxx"
                ]
            }
        ]
    }
}
Ctrl I