アラートルールの検索

以下の API を使用してアラートルールを検索できます。

リクエストURL

POST https://http-collector-observability.sixthsense.rakuten.com/api-externalization/api/v1/rules/search

ヘッダー

ヘッダーキー：Authorization

ヘッダー値：Bearer {{access_token}} （SixthSenceポータルで [設定] > [アクセストークン] > [アクセストークンの表示] に移動）

リクエスト

{
"from": 0,
"keyword": "string",
"limit": 0,
"order": "ASC",
"serviceId": "string",
"sortBy": "lastUpdatedAt"
}

例：

{
"keyword": "",
"limit": 10,
"from": 0,
"sortBy": "lastUpdatedAt",
"order": "ASC",
"serviceId": "eyduYW1lJzonQk0gQ2xpZW50IEFwcCcsJ3RlYW1JRCc6J2MyNjI4NmRiLTY3OTQtNGM0MS1hYjVmLThiNGFjOTU2NTU1MCcsJ3R5cGUnOidCJ30=.1"
}
パラメータ内容
keywordキーワードはルール名を検索するために使用されます。
limit返されるレコードの数
fromレコードの開始番号
sortBylastUpdatedAt
order
  • ASC : 昇順
  • DESC : 降順
    • serviceId/api/v1/services/search で指定された、ルールが必要なサービスのID

    応答

    {
    "data": {},
    "message": "string",
    "success": true
    }

    例：

    {
    "message": "1 record(s) found",
    "success": true,
    "data": {
    "rules": [
    {
    "ruleId": "YTMwNDI2YWItMWU3MC00ODQyLTgwOTItZWY4YzI2YTg3YjMzXzE2NzQwMzkyODg3Njc=",
    "ruleName": "Error count for code 401 greater than 1 for more than or equal to a count of 1 in a period of 5 mins",
    "metricDisplayName": "Error code",
    "aggregationType": "SUM",
    "aggregationValue": 0,
    "period": 5,
    "thresholdDisplayValue": "1",
    "thresholdDisplayUnit": "na",
    "operation": "GT",
    "silencePeriod": 5,
    "recoveryPeriod": 0,
    "lastUpdatedAt": 1674035660974,
    "createdBy": "API user",
    "createdAt": 1674035660974,
    "modified": 1,
    "modifiedBy": "API user",
    "active": true,
    "serviceId": "eyduYW1lJzonbm9kZS1hcHAtMicsJ3RlYW1JRCc6JzU5ZWRkZDE1LTIwMjQtNDA1OS05OGFlLTc5YTJjZTViYTEzNCcsJ3R5cGUnOidBJ30=.1",
    "channels": [
    ""
    ],
    "filters": [
    {
    "key": "service_error_code",
    "value": "401"
    }
    ],
    "instances": [
    {
    "key": "endpoint",
    "value": "http://www.google.com"
    }
    ]
    }
    ],
    "total": 1
    }
    }