一覧¶
GET /api/v1/incidents/schedule/list
概要¶
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| incidentsScheduleUUIDs | commaArray | インシデントスケジュールUUIDリスト 空を許可: False |
|
| mySchedule | string | 自分のスケジュールを表示、デフォルト false: すべてのスケジュールを表示 空を許可: True 選択可能な値: ['true', 'false'] |
|
| scheduleCalendar | string | スケジュールカレンダー、デフォルト false: スケジュール管理を表示 空を許可: True 選択可能な値: ['true', 'false'] |
|
| scTimezone | string | スケジュールカレンダー照会時のタイムゾーン、デフォルト Asia/Shanghai 例: Asia/Shanghai 空を許可: False 最大長: 48 |
|
| scDateRange | string | スケジュールカレンダー照会時の日付範囲、デフォルトは照会当日のみ 例: 2024/06/22~2024/07/06 空を許可: False 空文字列を許可: False 最大長: 48 |
|
| search | string | スケジュール名を検索 空を許可: True |
|
| pageIndex | integer | ページ番号 空を許可: False 例: 1 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却件数 空を許可: False 例: 10 $minValue: 1 $maxValue: 100 |
パラメータ補足説明¶
scheduleCalendar=true の場合、scheduleCalendarInfos[date][] は臨時代行を計算した後の実際のオンコール担当者を返すようになり、元のスケジュール担当者と同階層の overrideInfo による互換構造は返しません。
各カレンダー配列項目の主体アカウントフィールドは、そのタイムスライスの実際のオンコール担当者を表し、以下を含みます。
scheduleUUID: そのタイムスライスが属するオンコール設定の UUID。scheduleTimeRange: 実際のオンコールタイムスライス。臨時代行の開始・終了境界で分割されます。引き続き、終了秒を含む閉区間[startAt, endAt]を使用します。overrideInfo: ヒットした完全な臨時代行関係。ヒットしない場合はnullです。startAtは開始時刻を含む有効時刻、endAtは終了時刻を含まない停止時刻で、代行期間は[startAt, endAt)です。
代行関係の substituteTargetInfo は配列項目の主体アカウント情報と一致し、replacedTargetInfo は代行前の元のスケジュール担当者です。異なる代行関係が誤ってマージされることはありません。同一関係の複数の非連続タイムスライスは、同じ scheduleTimeRange 配列にマージできます。
カレンダーモードの例:
{
"scheduleCalendarInfos": {
"2026/08/16": [
{
"uuid": "acnt_substitute",
"name": "Bob",
"email": "xxx@guance.com",
"scheduleUUID": "incsch_xxx",
"scheduleTimeRange": [[1786838400, 1786856399]],
"overrideInfo": {
"uuid": "incschovr_xxx",
"scheduleUUID": "incsch_xxx",
"replacedTarget": "acnt_original",
"substituteTarget": "acnt_substitute",
"startAt": 1786838400,
"endAt": 1786856400,
"timezone": "Asia/Shanghai",
"replacedTargetInfo": {
"uuid": "acnt_original",
"name": "Alice",
"email": "xxx@guance.com"
},
"substituteTargetInfo": {
"uuid": "acnt_substitute",
"name": "Bob",
"email": "xxx@guance.com"
}
}
}
]
},
"scheduleCalendarUpdateInfos": {},
"totalCount": 1,
"myScheduleCount": 1,
"totalScheduleCount": 1
}
Front の同じパスのカレンダーインターフェースは、元のオンコール担当者と同階層の overrideInfo を持つ互換構造を引き続き維持します。OpenAPI の通常リスト、詳細、書き込みインターフェース、および AIAPI のオンコール一覧には影響しません。
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/incidents/schedule/list?pageIndex=1&pageSize=20' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"data": [
{
"workspaceUUID": "wksp_xxxx",
"name": "default",
"timezone": "Asia/Shanghai",
"start": "00:00",
"end": "23:59",
"tagFilter": [],
"dimensionFilter": "",
"notifyTargets": [],
"strategyConfig": [],
"extend": {
"rotationCycle": "day",
"enableRotateNotification": false
},
"isDefault": true,
"rotationUpdateAt": 1768803347,
"id": 6952,
"uuid": "incsch_xxx",
"status": 0,
"creator": "SYS",
"updator": "acnt_xxx",
"createAt": 1768803072,
"deleteAt": -1,
"updateAt": 1768803347,
"inEffectNotifyTargetsInfos": [],
"notifyTargetsInfos": [],
"effectiveTimeInfos": {
"timeStr": "",
"expired": false
},
"tagFilterInfos": []
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
},
"myScheduleCount": 1,
"totalScheduleCount": 1
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "xxx"
}