sla.get

説明

integer/array sla.get(object parameters)

このメソッドを使用すると、指定されたパラメーターに従ってSLAオブジェクトを取得できます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(object) は、必要な出力を定義するパラメータです。

このメソッドは以下のパラメータをサポートしています。

パラメータ	タイプ	説明
slaids	ID/配列	指定されたIDのSLAのみを返します。
serviceids	ID/配列	特定のサービスに一致するSLAのみを返します。
selectSchedule	クエリ	SLAスケジュールを含む`schedule`プロパティを返します。 `count`をサポートします。
selectExcludedDowntimes	クエリ	SLAから除外されるダウンタイムを含む`excluded_downtimes`プロパティを返します。 `count`をサポートします。
selectServiceTags	クエリ	SLA サービスタグを含む `service_tags` プロパティを返します。 `count` をサポートします。
sortfield	文字列/配列	指定されたプロパティで結果を並べ替えます。使用可能な値: `slaid`、`name`、`period`、`slo`、`effective_date`、`timezone`、`status`、`description`
countOutput	ブール値	これらのパラメータについては、リファレンス解説で説明されています。
editable	ブール値
excludeSearch	ブール値
filter	object
limit	integer
output	クエリ
preservekeys	ブール値
search	object
searchByAny	ブール値
searchWildcardsEnabled	ブール値
sortorder	文字列/配列
startSearch	ブール値

戻り値

(integer/array) 次のいずれかを返します:

オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数

例

すべてのSLAの取得

すべてのSLAとそのプロパティに関するすべてのデータを取得します。

リクエスト :

{
           "jsonrpc": "2.0",
           "method": "sla.get",
           "params": {
               "output": "extend",
               "selectSchedule": ["period_from", "period_to"],
               "selectExcludedDowntimes": ["name", "period_from", "period_to"],
               "selectServiceTags": ["tag", "operator", "value"],
               "preservekeys": true
           },
           "id": 1
       }

レスポンス :

{
           "jsonrpc": "2.0",
           "result": {
               "1": {
                   "slaid": "1",
                   "name": "Database Uptime",
                   "period": "1",
                   "slo": "99.9995",
                   "effective_date": "1672444800",
                   "timezone": "America/Toronto",
                   "status": "1",
                   "description": "Provide excellent uptime for main SQL database engines.",
                   "service_tags": [
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "MySQL"
                       },
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "PostgreSQL"
                       }
                   ],
                   "schedule": [
                       {
                           "period_from": "0",
                           "period_to": "601200"
                       }
                   ],
                   "excluded_downtimes": [
                       {
                           "name": "Software version upgrade rollout",
                           "period_from": "1648760400",
                           "period_to": "1648764900"
                       }
                   ]
               }
           },
           "id": 1
       }

ソース

CSla:get() in ui/include/classes/api/services/CSla.php.

Documentation

sla.get

説明

パラメータ

戻り値

例

すべてのSLAの取得

ソース