コンテンツにスキップ

作成¶

POST /api/v1/slo/add

概要¶

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
name	string	Y	SLO 名称空の許可: False 最大長: 256
interval	string	Y	検出頻度空の許可: False 選択可能値: ['5m', '10m'] 例: 5m
goal	float	Y	SLO 目標値、範囲: 0-100、0 と 100 は含まない空の許可: False 設定可能値の下限: 0 設定可能値の上限: 100 例: 90.0
minGoal	float	Y	SLO 最低目標値、範囲: 0-100、0 と 100 は含まない、かつ goal より小さい空の許可: False 設定可能値の下限: 0 設定可能値の上限: 100 例: 85.0
sliUUIDs	array	Y	SLI の UUID リスト空の許可: False 例: ['rul-aaaaaa', 'rul-bbbbbb']
describe	string		SLO グループ説明情報例: これはサンプルです空の許可: False 空文字列の許可: True 最大長: 3000
alertPolicyUUIDs	array		アラートポリシー UUID 空の許可: False
tags	array		フィルタリング用のタグ名空の許可: False 例: ['xx', 'yy']
groupBy	array		SLO 計算ディメンション。project、env、service のみサポート。DQL の by ディメンションはこのフィールドと一致します。デフォルトは [] 空の許可: False 例: ['project', 'env']
ignoreBadGroupEvents	boolean		SLO に groupBy を設定した場合、異常グループイベントを無視するかどうか。デフォルトは true。groupBy 未設定時は無効空の許可: False 例: True

パラメータ補足説明¶

sliUUIDs、SLI の UUID リスト。参照: モニタリング - モニター - モニター一覧の取得（search パラメータでモニター名を検索可能、その他のパラメータは省略可）でモニターの uuid フィールドを取得します。
alertOpt[#].alertTarget、アラート通知先。参照: モニタリング - 通知先管理 - 通知先一覧の取得

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/slo/add' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY:  <DF-API-KEY>' \
--data '{"name":"LWC-Test-2024-08-06-002","interval":"10m","goal":90,"minGoal":60,"sliUUIDs":["rul_xxxxx","rul_9eb745xx"],"describe":"LWCTestOpenAPI","tags":[],"alertPolicyUUIDs":["altpl_d8db4xxxx"],"groupBy":["project","env"],"ignoreBadGroupEvents":true}'

レスポンス¶

{
    "code": 200,
    "content": {
        "alertOpt": {},
        "config": {
            "checkRange": 604800,
            "describe": "LWCTestOpenAPI",
            "goal": 90,
            "interval": "10m",
            "minGoal": 60,
            "sli_infos": [
                {
                    "id": "rul_7xxxx",
                    "name": "lml-tes",
                    "status": 0
                },
                {
                    "id": "rul_9xxxx",
                    "name": "whytest-Feedback Problem Verification",
                    "status": 2
                }
            ]
        },
        "createAt": 1722913524,
        "creator": "wsak_a2d5xxx",
        "creatorInfo": {
            "uuid": "xx",
            "status": 0,
            "username": "xx",
            "name": "xx",
            "iconUrl": "",
            "email": "xx",
            "acntWsNickname": "xx"
        },
        "declaration": {
            "asd": "aa,bb,cc,1,True",
            "asdasd": "dawdawd",
            "business": "aaa",
            "fawf": "afawf",
            "organization": "64fe7b4062f74d0007b46676"
        },
        "deleteAt": -1,
        "id": null,
        "name": "LWC-Test-2024-08-06-002",
        "score": 0,
        "status": 0,
        "type": "slo",
        "updateAt": 1706152340,
        "updator": "xx",
        "updatorInfo": {
            "uuid": "xx",
            "status": 0,
            "username": "xx",
            "name": "xx",
            "iconUrl": "",
            "email": "xx",
            "acntWsNickname": "xx"
        },
        "uuid": "monitor_5exxxxx",
        "workspaceUUID": "wksp_4b57cxxxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "12912524534614287758"
}