一覧取得¶
GET /api/v1/issue/notification_policy/list
概要¶
現在のワークスペース内の未削除の通知ポリシーと、それに関連するスケジュール、チャンネル、アカウント情報をページングして照会します。
呼び出し前の準備と使用手順¶
デフォルトは pageIndex=1、pageSize=10 で、最終更新日時の降順です。未更新のポリシーは作成日時で比較します。一覧には有効と無効のポリシーが含まれ、status で区別します。ポリシー配列は content.data に、ページング情報はトップレベルの pageInfo にあります。返された uuid は詳細、変更、削除に使用するため保存してください。ポリシーはコンソールで対象チャンネルに関連付け、有効な通知スケジュールを関連付ける必要があります。実際の受信者はスケジュールのタイムゾーン、当日の時間帯、有効期間、ローテーション、通知先によって決まります。ポリシーの保存自体ではテスト通知はすぐに送信されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | ページ番号。デフォルトは 1、最小値は 1。 null を許可: False $minValue: 1 例: 1取得または入力方法: 1 からページごとに増やし、検索条件は同じに保ちます。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 10。 null を許可: False $maxValue: 100 $minValue: 1 例: 10取得または入力方法: 必要に応じて 1 から 100 の整数を入力します。 |
|
| search | string | 任意の名称あいまい検索。サーバー側で前後の空白を除去します。null を渡さないでください。 null を許可: True 例: 生产取得または入力方法: ポリシー名の一部を入力します。省略または空文字列の場合は絞り込みません。 |
パラメータ補足説明¶
返される関連スケジュール設定は、現時点の実際の受信者リストではありません。実際の通知先は、スケジュールの有効期間、時間帯、ローテーションに基づいて計算する必要があります。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/issue/notification_policy/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
現在ページのポリシー。結果がない場合は []。 |
| content.data[].id | integer | 保存済みポリシーのレコード番号。操作には uuid を使用します。 |
| content.data[].uuid | string | 通知ポリシー UUID。inpy_ で始まります。 |
| content.data[].workspaceUUID | string | 所属ワークスペース UUID。 |
| content.data[].name | string | ポリシー名。 |
| content.data[].status | integer | レコード状態。0 は有効、2 は無効、3 は削除。一覧には未削除の有効および無効ポリシーが含まれます。 |
| content.data[].creator | string | 作成した呼び出し元の識別情報。 |
| content.data[].updator | string | 最終更新した識別情報。未更新の場合は空文字列。 |
| content.data[].createAt | integer | 作成時刻、Unix 秒。 |
| content.data[].updateAt | integer | 更新時刻、Unix 秒。未更新の場合は -1。 |
| content.data[].deleteAt | integer | 削除時刻、Unix 秒。未削除の場合は -1。 |
| content.data[].extend | object | 保存された通知範囲とエスカレーションルール。{} の場合があります。 |
| content.data[].extend.notifyTypes | array<string> |
有効なアクションタイプ。 |
| content.data[].extend.notifyTypes[] | string | 単一のアクションタイプ。具体的な動作はパラメータ表を参照してください。 |
| content.data[].extend.upgradeCfg | object | トリガータイプ別に保存されたルール。 |
| content.data[].extend.upgradeCfg.noManager | object | Issue 作成時に有効な担当者がおらず、担当者なし候補に入り、ステータスが Open/Working/Pending の場合は、Issue 作成時から待機します。既存の Issue は担当者を削除しただけでは候補に再び入ることは保証されません。60 の倍数である正の整数秒を入力します。有効化タイプは issueUpgrade.noManager で、未設定の場合は省略されます。 |
| content.data[].extend.upgradeCfg.noManager.duration | integer | 初回の待機秒数。 |
| content.data[].extend.upgradeCfg.noManager.notifyType | string | once または cycle。この値が保存されていない場合は once として扱います。 |
| content.data[].extend.upgradeCfg.noManager.cycleDuration | integer | 循環間隔、単位は秒。cycle モードで使用します。 |
| content.data[].extend.upgradeCfg.noManager.cycleTimes | integer | 循環トリガーの総回数上限。1 から 30 までで、初回を含みます。 |
| content.data[].extend.upgradeCfg.processTimeout | object | Issue が Open/Working の状態で未完了のまま経過した時間。初回は作成時から計時します。Pending/Resolved/Closed から処理状態に再び入った場合は、再入後のステータス記録から計時します。有効化タイプは issueUpgrade.processTimeout で、未設定の場合は省略されます。 |
| content.data[].extend.upgradeCfg.processTimeout.duration | integer | 初回の待機秒数。 |
| content.data[].extend.upgradeCfg.processTimeout.notifyType | string | once または cycle。この値が保存されていない場合は once として扱います。 |
| content.data[].extend.upgradeCfg.processTimeout.cycleDuration | integer | 循環間隔、単位は秒。cycle モードで使用します。 |
| content.data[].extend.upgradeCfg.processTimeout.cycleTimes | integer | 循環トリガーの総回数上限。1 から 30 までで、初回を含みます。 |
| content.data[].extend.upgradeCfg.openProcessTimeout | object | Issue が Open のままの場合にのみ有効。最後のステータス変更時刻から計時します。ステータス記録がない場合は作成時刻から計時します。有効化タイプは issueUpgrade.processTimeout で、未設定の場合は省略されます。 |
| content.data[].extend.upgradeCfg.openProcessTimeout.duration | integer | 初回の待機秒数。 |
| content.data[].extend.upgradeCfg.openProcessTimeout.notifyType | string | once または cycle。この値が保存されていない場合は once として扱います。 |
| content.data[].extend.upgradeCfg.openProcessTimeout.cycleDuration | integer | 循環間隔、単位は秒。cycle モードで使用します。 |
| content.data[].extend.upgradeCfg.openProcessTimeout.cycleTimes | integer | 循環トリガーの総回数上限。1 から 30 までで、初回を含みます。 |
| content.data[].extend.upgradeCfg.eventStorm | object | Issue に記録された eventCount が exceedTimes を厳密に超えた後にトリガーされます。Open/Working ステータスによる限定はなく、完了済みの Issue も数量条件を満たす場合があります。有効化タイプは issueUpgrade.eventStorm で、未設定の場合は省略されます。 |
| content.data[].extend.upgradeCfg.eventStorm.exceedTimes | integer | 数量しきい値。eventCount が厳密に超えた場合のみトリガーされます。 |
| content.data[].extend.upgradeCfg.eventStorm.notifyType | string | once または cycle。この値が保存されていない場合は once として扱います。 |
| content.data[].extend.upgradeCfg.eventStorm.cycleDuration | integer | 循環間隔、単位は秒。cycle モードで使用します。 |
| content.data[].extend.upgradeCfg.eventStorm.cycleTimes | integer | 循環トリガーの総回数上限。1 から 30 までで、初回を含みます。 |
| content.data[].extend.其他字段 | JSON | ソースから保存されたその他の拡張フィールド。すべてが通知動作を制御できるわけではありません。 |
| content.data[].relNotificationScheduleInfos | array<object> |
関連付けられた有効なスケジュールオブジェクト。一覧には書式化された有効期間も含まれますが、詳細では元のスケジュール設定のみです。 |
| content.data[].relNotificationScheduleInfos[].id | integer | データベースのレコード番号。スケジュールの操作には uuid を使用します。 |
| content.data[].relNotificationScheduleInfos[].uuid | string | スケジュール UUID。照会、変更、削除、通知ポリシーからの参照に使用します。 |
| content.data[].relNotificationScheduleInfos[].workspaceUUID | string | 所属ワークスペース UUID。 |
| content.data[].relNotificationScheduleInfos[].name | string | スケジュール名。 |
| content.data[].relNotificationScheduleInfos[].timezone | string | このスケジュールが当日の時間帯と有効日を解釈するために使用する IANA タイムゾーン。 |
| content.data[].relNotificationScheduleInfos[].start | string | 当日の開始時刻 HH:MM。 |
| content.data[].relNotificationScheduleInfos[].end | string | 当日の終了時刻 HH:MM。終了分の最後の秒まで有効です。 |
| content.data[].relNotificationScheduleInfos[].notifyTargets | array<string> |
順番に保存されたメンバー、通知先 UUID、またはメールアドレス。 |
| content.data[].relNotificationScheduleInfos[].notifyTargets[] | string | acnt_ アカウント、notify_ 通知先、またはメールアドレス文字列。 |
| content.data[].relNotificationScheduleInfos[].extend | object | 拡張設定。未設定の場合は {} の場合があります。 |
| content.data[].relNotificationScheduleInfos[].extend.enableRotateNotification | boolean | ローテーションを有効にするか。省略時は false として扱います。 |
| content.data[].relNotificationScheduleInfos[].extend.rotationCycle | string | ローテーション有効時の周期。day は日ごと、week は月曜日ごと、month は暦月ごと、workDay は平日のみ日ごと、weekend は週末のみ日ごと。祝日は識別しません。未設定の場合は省略できます。 |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime | object | 全体の有効期間。未設定の場合は省略できます。 |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime.start | integer | 有効期間の開始 Unix 秒。0 または省略時は制限なし。 |
| content.data[].relNotificationScheduleInfos[].extend.effectiveTime.end | integer | 有効期間の終了 Unix 秒。0 または省略時は制限なし。 |
| content.data[].relNotificationScheduleInfos[].rotationUpdateAt | integer | ローテーション計算の開始時刻、Unix 秒。ローテーション関連の設定を変更するとリセットされます。 |
| content.data[].relNotificationScheduleInfos[].status | integer | レコード状態。アクティブなレコードは 0。 |
| content.data[].relNotificationScheduleInfos[].creator | string | 作成した呼び出し元の識別情報。 |
| content.data[].relNotificationScheduleInfos[].updator | string | 最終更新した識別情報。未更新の場合は空文字列。 |
| content.data[].relNotificationScheduleInfos[].createAt | integer | 作成時刻、Unix 秒。 |
| content.data[].relNotificationScheduleInfos[].updateAt | integer | 更新時刻、Unix 秒。未更新の場合は -1。 |
| content.data[].relNotificationScheduleInfos[].deleteAt | integer | 削除時刻、Unix 秒。未削除の場合は -1。 |
| content.data[].relChannelInfos | array<object> |
このポリシーを参照するチャンネルオブジェクト。 |
| content.data[].relChannelInfos[].id | integer | チャンネルレコード番号。 |
| content.data[].relChannelInfos[].uuid | string | チャンネル UUID。変更、削除、購読に使用します。 |
| content.data[].relChannelInfos[].workspaceUUID | string | チャンネルが属するワークスペース。 |
| content.data[].relChannelInfos[].name | string | チャンネル名。default はデフォルトチャンネルを表します。 |
| content.data[].relChannelInfos[].description | string | チャンネルの説明。 |
| content.data[].relChannelInfos[].notifyTarget | array<string> |
このチャンネルに直接設定された通知先 UUID。 |
| content.data[].relChannelInfos[].notifyTarget[] | string | 単一の通知先 UUID。 |
| content.data[].relChannelInfos[].notifyUpgradeCfg | object | エスカレーション通知設定。未設定の場合は空オブジェクト。 |
| content.data[].relChannelInfos[].notifyUpgradeCfg.triggerTime | integer | エスカレーション通知をトリガーする待機時間、単位は秒。 |
| content.data[].relChannelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
エスカレーション通知先 UUID のリスト。 |
| content.data[].relChannelInfos[].notifyUpgradeCfg.notifyTarget[] | string | エスカレーション通知先 UUID。 |
| content.data[].relChannelInfos[].status | integer | レコード状態。正常は 0。 |
| content.data[].relChannelInfos[].creator | string | 作成した呼び出し元の識別情報。 |
| content.data[].relChannelInfos[].updator | string | 最終更新した識別情報。未更新の場合は空文字列。 |
| content.data[].relChannelInfos[].createAt | integer | 作成時刻、Unix 秒。 |
| content.data[].relChannelInfos[].updateAt | integer | 更新時刻、Unix 秒。未更新の場合は -1。 |
| content.data[].relChannelInfos[].deleteAt | integer | 削除時刻、Unix 秒。未削除の場合は -1。 |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos | object | 一覧で補足されるスケジュール全体の有効期間表示情報。 |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos.timeStr | string | 書式化された有効期間。空文字列の場合があります。 |
| content.data[].relNotificationScheduleInfos[].effectiveTimeInfos.expired | boolean | 全体の有効期間が終了したか。 |
| content.data[].creatorInfo | object または null | 作成/更新した識別情報の解決可能なアカウント情報。API Key は自然人メンバーではないため、一覧では null を返すことがあり、詳細では空オブジェクトの場合があります。以下のフィールドは識別情報に応じて任意です。 |
| content.data[].creatorInfo.id | integer | アカウントレコード番号。 |
| content.data[].creatorInfo.uuid | string | アカウント UUID。 |
| content.data[].creatorInfo.name | string | アカウント名。 |
| content.data[].creatorInfo.username | string | ログイン名。 |
| content.data[].creatorInfo.email | string | アカウントのメールアドレス。 |
| content.data[].creatorInfo.source | string | アカウントのソース。 |
| content.data[].creatorInfo.userIconUrl | string | アイコン URL。 |
| content.data[].creatorInfo.exterId | string | 外部識別子。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。 |
| content.data[].creatorInfo.countryCode | string | 国/地域コード。 |
| content.data[].creatorInfo.namespace | string | 識別情報の名前空間。 |
| content.data[].creatorInfo.attributes | object または array | ソースから提供されたアカウント属性。 |
| content.data[].creatorInfo.attributes.自定义字段 | JSON | 識別情報ソースによって定義された属性。 |
| content.data[].creatorInfo.customAttributes | object または array | カスタムアカウント属性。 |
| content.data[].creatorInfo.customAttributes.自定义字段 | JSON | カスタムアカウント属性値。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。 |
| content.data[].creatorInfo.defaultWebhook | object | 一部のエージェントアカウントのデフォルト Webhook 情報。省略できます。 |
| content.data[].creatorInfo.defaultWebhook.自定义字段 | JSON | アカウントソースに応じて設定された Webhook フィールド。 |
| content.data[].updatorInfo | object または null | 作成/更新した識別情報の解決可能なアカウント情報。API Key は自然人メンバーではないため、一覧では null を返すことがあり、詳細では空オブジェクトの場合があります。以下のフィールドは識別情報に応じて任意です。 |
| content.data[].updatorInfo.id | integer | アカウントレコード番号。 |
| content.data[].updatorInfo.uuid | string | アカウント UUID。 |
| content.data[].updatorInfo.name | string | アカウント名。 |
| content.data[].updatorInfo.username | string | ログイン名。 |
| content.data[].updatorInfo.email | string | アカウントのメールアドレス。 |
| content.data[].updatorInfo.source | string | アカウントのソース。 |
| content.data[].updatorInfo.userIconUrl | string | アイコン URL。 |
| content.data[].updatorInfo.exterId | string | 外部識別子。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。 |
| content.data[].updatorInfo.countryCode | string | 国/地域コード。 |
| content.data[].updatorInfo.namespace | string | 識別情報の名前空間。 |
| content.data[].updatorInfo.attributes | object または array | ソースから提供されたアカウント属性。 |
| content.data[].updatorInfo.attributes.自定义字段 | JSON | 識別情報ソースによって定義された属性。 |
| content.data[].updatorInfo.customAttributes | object または array | カスタムアカウント属性。 |
| content.data[].updatorInfo.customAttributes.自定义字段 | JSON | カスタムアカウント属性値。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。 |
| content.data[].updatorInfo.defaultWebhook | object | 一部のエージェントアカウントのデフォルト Webhook 情報。省略できます。 |
| content.data[].updatorInfo.defaultWebhook.自定义字段 | JSON | アカウントソースに応じて設定された Webhook フィールド。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
| pageInfo | object | トップレベルのページング情報。 |
| pageInfo.pageIndex | integer | ページ番号。 |
| pageInfo.pageSize | integer | ページ容量。 |
| pageInfo.count | integer | 現在ページの実際の件数。 |
| pageInfo.totalCount | integer | 一致するポリシーの総数。 |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "inpy_example",
"workspaceUUID": "wksp_example",
"name": "生产异常通知",
"extend": {
"notifyTypes": [
"issue.add",
"issue.modify",
"issueReply.add",
"issueUpgrade.noManager",
"issueUpgrade.processTimeout",
"issueUpgrade.eventStorm"
],
"upgradeCfg": {
"noManager": {
"duration": 600,
"notifyType": "once"
},
"processTimeout": {
"duration": 1800,
"notifyType": "cycle",
"cycleDuration": 600,
"cycleTimes": 3
},
"openProcessTimeout": {
"duration": 900,
"notifyType": "once"
},
"eventStorm": {
"exceedTimes": 60,
"notifyType": "once"
}
}
},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"relNotificationScheduleInfos": [],
"relChannelInfos": [],
"creatorInfo": null,
"updatorInfo": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 500 | ft.InternalServerError | ポリシーまたは関連情報の読み取り失敗 | 内部エラー | 後で再試行してください。継続的に失敗する場合は traceId を提供してください。 |