الانتقال إلى المحتوى الرئيسي
PUT
/
sla
/
schedules
/
{scheduleId}
تحديث جدول تقرير
curl --request PUT \
  --url https://api.altostrat.io/sla/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "ملخص SLA التنفيذي الشهري",
  "disabled": false,
  "daily": true,
  "weekly": true,
  "monthly": true,
  "day_of_week": "monday",
  "day_of_month": 1,
  "sla_target": 99.95,
  "show_only_breached_sites_in_pdf": false,
  "calculate_sla_within_schedule_hours": true,
  "business_hours_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "site_selection_mode": "tags",
  "site_selection_logic": "or",
  "site_selection_rules": [
    {
      "key": "المنطقة",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "المنطقة",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "مجموعة_مسؤولي_الشبكة"
}'
{
  "id": "sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7",
  "name": "ملخص SLA التنفيذي الشهري",
  "disabled": false,
  "daily": true,
  "weekly": true,
  "monthly": true,
  "day_of_week": "monday",
  "day_of_month": 1,
  "sla_target": 99.95,
  "show_only_breached_sites_in_pdf": false,
  "calculate_sla_within_schedule_hours": true,
  "business_hours_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "site_selection_mode": "tags",
  "site_selection_logic": "or",
  "site_selection_rules": [
    {
      "key": "المنطقة",
      "value": "APAC"
    }
  ],
  "grouping_rules": [
    {
      "key": "المنطقة",
      "aggregation": "avg"
    }
  ],
  "sites": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "recipients": [
    "e47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "timezone": "Australia/Sydney",
  "ignore_power_outages": false,
  "notification_group": "مجموعة_مسؤولي_الشبكة",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

أدخل رمز المصادقة الخاص بك.

Path Parameters

​
scheduleId
string
required

المعرف الفريد لجدول تقرير SLA المراد تحديثه، مسبوقًا بـ sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

Body

application/json

تكوين جدول تقرير SLA المحدث.

الخصائص المطلوبة لإنشاء أو تحديث جدول تقرير SLA.

​
name
string
required

اسم سهل القراءة لجدول التقرير.

Example:

"ملخص SLA التنفيذي الشهري"

​
sla_target
number
required

النسبة المئوية المستهدفة لاتفاقية مستوى الخدمة. سيتم تمييز المواقع التي يقل وقت تشغيلها عن هذه القيمة على أنها منتهكة.

Example:

99.95

​
business_hours_id
string<uuid>
required

معرف UUID لجدول ساعات العمل المراد استخدامه لحسابات SLA.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

​
site_selection_mode
enum<string>
required

يحدد كيفية اختيار المواقع للتقرير. manual يستخدم مصفوفة sites. tags يستخدم الاختيار الديناميكي بناءً على site_selection_rules.

الخيارات المتاحة:
manual,
tags
Example:

"tags"

​
timezone
string
required

معرف المنطقة الزمنية IANA لجدولة التقرير (على سبيل المثال، 'America/New_York'). يتم تشغيل التقارير في الساعة 8 صباحًا في هذه المنطقة الزمنية.

Example:

"Australia/Sydney"

​
notification_group
string
required

معرف مجموعة الإشعارات لإرسال التقرير إليها.

Example:

"مجموعة_مسؤولي_الشبكة"

​
disabled
boolean
default:false

إذا كانت القيمة true، يتم إيقاف الجدول مؤقتًا ولن يُنشئ تقارير تلقائيًا.

​
daily
boolean

إذا كانت القيمة true، يتم تشغيل التقرير كل يوم. يجب أن تكون واحدة فقط من daily أو weekly أو monthly صحيحة.

​
weekly
boolean

إذا كانت القيمة true، يتم تشغيل التقرير مرة واحدة في الأسبوع في day_of_week المحدد.

​
monthly
boolean

إذا كانت القيمة true، يتم تشغيل التقرير مرة واحدة في الشهر في day_of_month المحدد.

​
day_of_week
enum<string>

مطلوب إذا كانت weekly تساوي true. يوم الأسبوع لتشغيل التقرير.

الخيارات المتاحة:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
Example:

"monday"

​
day_of_month
integer

مطلوب إذا كانت monthly تساوي true. يوم الشهر لتشغيل التقرير.

Required range: 1 <= x <= 28
Example:

1

​
show_only_breached_sites_in_pdf
boolean
default:false

إذا كانت القيمة true، فسيعرض ملف PDF المُنشأ فقط المواقع التي انتهكت هدف SLA.

​
calculate_sla_within_schedule_hours
boolean
default:true

إذا كانت القيمة true، يتم حساب SLA فقط ضمن ساعات العمل المحددة. إذا كانت false، يتم حسابه على مدار 24/7.

​
site_selection_logic
enum<string>

عندما يكون site_selection_mode هو tags، يحدد هذا كيفية دمج القواعد المتعددة. or يشمل المواقع التي تطابق أي قاعدة. and يشمل المواقع التي تطابق جميع القواعد.

الخيارات المتاحة:
or,
and
Example:

"or"

​
site_selection_rules
object[]

قائمة بالقواعد لاختيار المواقع ديناميكيًا بناءً على العلامات. مطلوب إذا كان site_selection_mode هو tags.

​
grouping_rules
object[]

قائمة اختيارية من القواعد لتجميع المواقع في التقرير حسب قيمة علامة معينة (على سبيل المثال، التجميع حسب 'المنطقة').

​
sites
string<uuid>[]

قائمة بمعرفات UUID للمواقع لتضمينها في التقرير. مطلوب إذا كان site_selection_mode هو manual.

​
recipients
string<uuid>[]

قائمة بمعرفات UUID للمستلمين لإشعارهم عندما يكون التقرير جاهزًا.

​
ignore_power_outages
boolean
default:false

إذا كانت القيمة true، فسيتم استبعاد وقت التوقف الناجم عن انقطاع التيار الكهربائي من حسابات SLA.

Response

تم تحديث الجدول بنجاح.

تكوين لتقرير SLA مجدول.

​
id
string

المعرف الفريد الذي أنشأه الخادم للجدول، مسبوقًا بـ sla_.

Example:

"sla_2ayc4Yy6w3g7Y2j4g4g4Yy6w3g7"

​
name
string

اسم سهل القراءة لجدول التقرير.

Example:

"ملخص SLA التنفيذي الشهري"

​
disabled
boolean
default:false

إذا كانت القيمة true، يتم إيقاف الجدول مؤقتًا ولن يُنشئ تقارير تلقائيًا.

​
daily
boolean

إذا كانت القيمة true، يتم تشغيل التقرير كل يوم. يجب أن تكون واحدة فقط من daily أو weekly أو monthly صحيحة.

​
weekly
boolean

إذا كانت القيمة true، يتم تشغيل التقرير مرة واحدة في الأسبوع في day_of_week المحدد.

​
monthly
boolean

إذا كانت القيمة true، يتم تشغيل التقرير مرة واحدة في الشهر في day_of_month المحدد.

​
day_of_week
enum<string>

يوم الأسبوع لتشغيل التقرير إذا كانت weekly تساوي true.

الخيارات المتاحة:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
Example:

"monday"

​
day_of_month
integer

يوم الشهر لتشغيل التقرير إذا كانت monthly تساوي true.

Required range: 1 <= x <= 28
Example:

1

​
sla_target
number

النسبة المئوية المستهدفة لاتفاقية مستوى الخدمة. سيتم تمييز المواقع التي يقل وقت تشغيلها عن هذه القيمة على أنها منتهكة.

Example:

99.95

​
show_only_breached_sites_in_pdf
boolean
default:false

إذا كانت القيمة true، فسيعرض ملف PDF المُنشأ فقط المواقع التي انتهكت هدف SLA.

​
calculate_sla_within_schedule_hours
boolean
default:true

إذا كانت القيمة true، يتم حساب SLA فقط ضمن ساعات العمل المحددة. إذا كانت false، يتم حسابه على مدار 24/7.

​
business_hours_id
string<uuid>

معرف UUID لجدول ساعات العمل المراد استخدامه لحسابات SLA.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

​
site_selection_mode
enum<string>

يحدد كيفية اختيار المواقع للتقرير. manual يستخدم مصفوفة sites. tags يستخدم الاختيار الديناميكي بناءً على site_selection_rules.

الخيارات المتاحة:
manual,
tags
Example:

"tags"

​
site_selection_logic
enum<string>

عندما يكون site_selection_mode هو tags، يحدد هذا كيفية دمج القواعد المتعددة. or يشمل المواقع التي تطابق أي قاعدة. and يشمل المواقع التي تطابق جميع القواعد.

الخيارات المتاحة:
or,
and
Example:

"or"

​
site_selection_rules
object[]

قائمة بالقواعد لاختيار المواقع ديناميكيًا بناءً على العلامات. مطلوب إذا كان site_selection_mode هو tags.

​
grouping_rules
object[]

قائمة اختيارية من القواعد لتجميع المواقع في التقرير حسب قيمة علامة معينة (على سبيل المثال، التجميع حسب 'المنطقة').

​
sites
string<uuid>[]

قائمة بمعرفات UUID للمواقع لتضمينها في التقرير. مطلوب إذا كان site_selection_mode هو manual.

​
recipients
string<uuid>[]

قائمة بمعرفات UUID للمستلمين لإشعارهم عندما يكون التقرير جاهزًا.

​
timezone
string

معرف المنطقة الزمنية IANA لجدولة التقرير (على سبيل المثال، 'America/New_York'). يتم تشغيل التقارير في الساعة 8 صباحًا في هذه المنطقة الزمنية.

Example:

"Australia/Sydney"

​
ignore_power_outages
boolean
default:false

إذا كانت القيمة true، فسيتم استبعاد وقت التوقف الناجم عن انقطاع التيار الكهربائي من حسابات SLA.

​
notification_group
string | null

معرف مجموعة الإشعارات لإرسال التقرير إليها.

Example:

"مجموعة_مسؤولي_الشبكة"

​
created_at
string<date-time>

الطابع الزمني عند إنشاء الجدول.

​
updated_at
string<date-time>

الطابع الزمني عند آخر تحديث للجدول.