変更¶
POST /api/v1/issue/{issue_uuid}/modify
概要¶
Issue のタイトル、説明、レベル、担当者、ステータスを更新し、変更を記録して通知を送信します。
呼び出し前の準備と使用手順¶
まず Issue 詳細 を読み、保持する完全な extend オブジェクトをコピーしてから、対象フィールドを送信します。name、description、level、statusType を省略した場合は現在値を保持します。extend は現在必ず送信する必要があり、{} を送ると拡張内容が置き換えられ、元の担当者などの情報が消去される可能性があります。extend.channels は関連付け済みチャンネルを追加するだけであり、[] を送っても既存チャンネルは解除されません。レベル、担当者、ステータスを更新すると操作記録が生成されます。Resolved/Closed の記録では resolveAt が記録され、再オープンしてもその履歴値はクリアされません。添付ファイルを追加する場合は先にアップロードし、attachmentUuids を送信して関連付けます。既存の添付ファイル記録は再関連付けできますが、省略または [] を送っても元の関連付けはクリアされません。既存の添付ファイルを削除する場合は添付ファイル削除 API を使用します。API の成功は通知の配信を意味しません。通知は非同期で実行され、受信者はチャンネル購読、通知先、通知ポリシー、担当者、および今回の @ メンバーによって決まります。コンソールで通知設定と実際の配信状況を確認してください。書き込みと後続の通知、添付ファイル処理は段階的に実行されます。失敗またはタイムアウトした場合は、まずリソースが作成または更新済みかどうかを確認してから再試行を判断し、記録や通知の重複を避けてください。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_uuid | string | Y | 現在のワークスペースの Issue UUID。 例: issue_example取得または入力方法: Issue 一覧 の content.data[].uuid、または Issue を作成 レスポンスの content.uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| attachmentUuids[*] | json | アップロード済みの単一添付ファイル UUID。 例: att_example取得または入力方法: 添付ファイルをアップロード の content.attachmentUuid を取得します。 |
|
| extend.text | json | 任意のプレーンテキスト。サーバー側の長さチェックに使用され、最大 3000 文字です。 例: 定位生产接口延迟。取得または入力方法: 説明のプレーンテキストから抽出し、3000 文字以内に収めます。省略した場合は空テキストとしてチェックされます。 |
|
| extend.channels | array | チャンネル参照配列。関連付け済みチャンネルに追加マージされ、[] を送っても既存の関連付けはクリアされません。 例: [{"type": "#", "uuid": "chan_example", "name": "生产异常"}]取得または入力方法: チャンネル一覧 から実際のチャンネル UUID を取得し、説明内の # チャンネルを参照します。省略した場合は追加されません。 |
|
| extend.channels[*] | json | チャンネル参照オブジェクト。 例: {"type": "#", "uuid": "chan_example", "name": "生产异常"}取得または入力方法: 各項目には同じワークスペースの実際のチャンネルを選択します。 |
|
| extend.channels[*].uuid | json | チャンネル UUID。 例: chan_example取得または入力方法: チャンネル一覧 の content[].uuid から取得します。 |
|
| extend.channels[*].name | json | クライアント表示名。 例: 生产异常取得または入力方法: チャンネル一覧 から対応する name を取得して表示に使用します。省略可能です。 |
|
| extend.channels[*].type | json | チャンネル参照マーカー。 例: #取得または入力方法: チャンネル参照では固定で # を使用します。サーバーは読み取り結果にこのマーカーを補完します。 |
|
| extend.channels[*].exists | json | 任意の表示マーカー。サーバー側のリソース検証の代替にはなりません。 例: true取得または入力方法: 有効性の証明として渡す必要はありません。クエリレスポンスでは現在のリソース存在性に基づいて再計算されます。 |
|
| extend.members | array | 今回の @ メンバー参照。一時的な通知メールアドレスの収集に使用され、担当者配列ではありません。 例: [{"type": "@", "uuid": "acnt_example", "name": "值班工程师"}]取得または入力方法: 対象ワークスペースのメンバー管理からアカウント UUID を取得します。省略した場合は今回の @ メンバーは追加されません。 |
|
| extend.members[*] | json | メンバー参照オブジェクト。 例: {"type": "@", "uuid": "acnt_example", "name": "值班工程师"}取得または入力方法: @ が必要な各アカウントのオブジェクトを入力します。 |
|
| extend.members[*].uuid | json | メンバーアカウント UUID。 例: acnt_example取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID を取得します。 |
|
| extend.members[*].name | json | クライアント表示名。 例: 值班工程师取得または入力方法: メンバーの表示名を使用します。省略可能です。 |
|
| extend.members[*].type | json | メンバー参照マーカー。 例: @取得または入力方法: メンバー参照では @ を使用します。 |
|
| extend.members[*].exists | json | 任意の表示マーカー。 例: true取得または入力方法: 有効性の証明として渡す必要はなく、クエリ時に再計算されます。 |
|
| extend.extra | json | 外部表示情報。API の実際の認証/作成者アイデンティティを置き換えません。 例: {}取得または入力方法: サードパーティ連携で外部操作者を表示する必要がある場合に入力します。ない場合は省略または {} です。 |
|
| extend.extra.creator | json | 作成者表示オブジェクト。 例: {"name": "外部工单创建人", "email": "xxx@guance.com"}取得または入力方法: 連携システムからの作成者。変更時、既存の creator は通常サーバー側で保持されます。 |
|
| extend.extra.creator.name | json | 表示名。省略可能。 例: 外部工单创建人取得または入力方法: 外部システムの表示名を取得します。 |
|
| extend.extra.creator.email | json | 表示メールアドレス。省略可能。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを取得します。例は架空のアドレスです。 |
|
| extend.extra.updator | json | 更新者表示オブジェクト。 例: {"name": "外部工单更新人", "email": "xxx@guance.com"}取得または入力方法: 変更時は連携システムにおける今回の操作者情報を取得します。 |
|
| extend.extra.updator.name | json | 表示名。省略可能。 例: 外部工单更新人取得または入力方法: 外部システムの表示名を取得します。 |
|
| extend.extra.updator.email | json | 表示メールアドレス。省略可能。 例: xxx@guance.com取得または入力方法: 外部システムのメールアドレスを取得します。 |
|
| extend.manager | array | 担当者識別子配列。担当者なしの場合は [] または省略です。変更時は完全な対象配列を送信します。無効なアカウント/チーム/通知先はフィルタリングされる場合があります。dutyPerson はワークスペースのタイムゾーンにおける当日のオンコールカレンダーに基づいて具体的な対象に解決され、当日の HH:MM 時間帯では判定されません。今回保存した後、その後のシフト変更に伴って自動変更されることはありません。 例: ["acnt_example"]取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID、チーム管理から group_ UUID を取得します。通知先 UUID は 通知先一覧 から取得します。実際のメールアドレスまたは dutyPerson を入力することもできます。 |
|
| extend.manager[*] | json | アカウント UUID、チーム UUID、通知先 UUID、メールアドレス、または dutyPerson。 例: acnt_example取得または入力方法: 対象ワークスペースのメンバー管理から acnt_ アカウント UUID、チーム管理から group_ UUID を取得します。通知先 UUID は 通知先一覧 から取得します。実際のメールアドレスまたは dutyPerson を入力することもできます。 |
|
| extend.linkList | array | 参考リンク配列。クライアントの必要に応じて保存されます。 例: [{"name": "处理手册", "link": "https://example.com/runbook"}]取得または入力方法: ビジネス側が提供するアクセス可能な参考リンク。省略した場合は追加されません。 |
|
| extend.linkList[*] | json | リンクオブジェクト。 例: {"name": "处理手册", "link": "https://example.com/runbook"}取得または入力方法: 各項目は 1 つの参考リンクを表します。 |
|
| extend.linkList[*].name | json | リンク名。 例: 处理手册取得または入力方法: リンクの表示名を入力します。 |
|
| extend.linkList[*].link | json | リンクアドレス。 例: https://example.com/runbook取得または入力方法: 完全なアクセス可能 URL を入力します。例のドメインは置き換えが必要です。 |
|
| extend.sourceLink | json | 任意のソースリンク。viewer の単一データ分析時、doc_time に基づいてレコードをカバーするクエリウィンドウを特定できます。 例: https://example.com/source?doc_time=1785430800000取得または入力方法: コンソールのソースページから完全なリンクを取得します。viewer ソースの doc_time は Unix ミリ秒を使用します。 |
|
| extend.extra.managerInfos | json | メールアドレス担当者の表示情報マップ。省略可能。 例: {"xxx@guance.com": {"name": "外部值班人"}}取得または入力方法: extend.manager 内のメールアドレスをキーとして、外部担当者の表示情報を入力します。 |
|
| extend.extra.managerInfos.邮箱.name | json | 単一のメールアドレス担当者の表示名。 例: 外部值班人取得または入力方法: メールアドレスキーは担当者配列内のメールアドレスと一致する必要があります。氏名は外部業務システムから取得します。 |
|
| attachmentUuids | array | 任意のアップロード済み添付ファイル UUID 配列。空でない場合、各項目をこの Issue にバインドまたは再バインドします。省略または [] を送っても既存の添付ファイルは削除されません。 null を許可: True 例: []取得または入力方法: 先に 添付ファイルをアップロード を呼び出し、content.attachmentUuid を保存します。このワークスペースで実際にアップロードされ利用可能な添付ファイルのみ使用できます。省略または [] では添付ファイルは追加されません。 |
|
| description | string | 任意の新しい説明。省略した場合は元の値を保持します。 null を許可: False 例: 定位生产接口延迟,记录处理过程。取得または入力方法: 現象、範囲、処理目標を記入します。詳細な診断資料は添付ファイルとしてアップロードできます。 |
|
| extend | json | Y | 必須の拡張オブジェクト。null を渡さないでください。オブジェクトを渡すと保存済みの拡張内容が置き換えられます。一部の作成者表示情報はサーバー側で保持されます。 null を許可: True 例: {}取得または入力方法: 拡張内容がない場合は {} を送信します。変更前に元の値を読み取り、完全なオブジェクト内で変更が必要なフィールドを調整します。 |
| level | string | 任意の新しいレベル UUID。省略した場合は現在のレベルを保持し、空文字列はレベルをクリアします。 空文字列を許可: True null を許可: False 例: system_level_1取得または入力方法: 先に 有効なレベル一覧 を呼び出し、実際に返された uuid を取得します。レベルを指定しない場合は空文字列を送信します。 |
|
| name | string | Issue のタイトル。最大 256 文字。 null を許可: False $maxCustomLength: 256 例: checkout-api 延迟异常取得または入力方法: 問題の現象に応じて明確なタイトルを入力します。 |
|
| statusType | integer | 任意のステータス。省略した場合は変更なし。ステータス: 10 Open、15 Working、20 Resolved、25 Closed、30 Pending。 null を許可: False 選択可能な値: [10, 15, 20, 25, 30] 例: 15取得または入力方法: 業務の処理進捗に応じて 10/15/20/25/30 を選択します。 |
パラメータ補足説明¶
本 API は resourceType/resourceUUID/resource を変更せず、Issue の削除機能も提供しません。添付ファイル管理は 返信を作成 と 添付ファイルを削除 を組み合わせて処理してください。一括再試行の前に、まず最終状態を確認してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/issue_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"statusType":15,"extend":{}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。Issue/返信の作成レスポンスは永続化前に構築される場合があり、null になることがあります。リソース操作には uuid を使用してください。 |
| content.uuid | string | リソース UUID。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.status | integer | レコードステータス。0 は正常、3 は削除済み。Issue の業務ステータス statusType とは区別します。 |
| content.creator | string | 作成呼び出しアイデンティティ。API Key 識別子、アカウント、システムアイデンティティの場合があります。 |
| content.updator | string | 最終更新アイデンティティ。未設定の場合は空文字列です。 |
| content.createAt | integer | 作成時間、Unix 秒。 |
| content.updateAt | integer | 最終更新時間、Unix 秒。未更新の場合は -1 の場合があります。 |
| content.deleteAt | integer | 削除時間、Unix 秒。未削除の場合は -1 です。 |
| content.name | string | Issue のタイトル。 |
| content.level | string | レベル UUID。空文字列は未指定を表し、レベル名ではありません。 |
| content.statusType | integer | ステータス: 10 Open、15 Working、20 Resolved、25 Closed、30 Pending。 |
| content.statusTypeUpdateRecord | array<string> |
ステータス変更履歴。各項目は Unix秒&&ステータス名 の形式です。 |
| content.statusTypeUpdateRecord[] | string | 単一のステータス変更記録。 |
| content.description | string | Issue の説明。 |
| content.resourceType | string | ソースタイプ。event、dashboard、viewer など。自動作成の場合は checker、keyeventAutoDiscovery などになることもあります。 |
| content.resourceUUID | string | 関連ソース識別子。具体的な意味はソースタイプによって変わります。 |
| content.resource | string | ソースモジュールまたは名前。例: LOG、TRACING、EVENTS、RUM。 |
| content.repeatType | string | 自動検出問題の重複タイプ。new、repeat、regression のいずれか。手動作成の場合は空の場合があります。 |
| content.subIdentify | string | ソース定義の関連サブ識別子。手動作成では通常空です。 |
| content.resolveAt | integer | 最後に Resolved または Closed に設定された時間、Unix 秒。一度も復旧していない場合は -1。再オープンしてもこの履歴時間は自動的にクリアされません。 |
| content.eventCount | integer | 記録された関連イベント数。 |
| content.eventCountUpdateAt | integer | 関連イベント数の最終更新時間、Unix 秒。まだ記録されていない場合は -1。 |
| content.triggerRecord | object | 履歴互換フィールド。通知トリガー制御パラメータとしては現在使用されません。 |
| content.extend | object | 拡張内容。リクエストではオブジェクト {} を送信し、null を送らないでください。メンバー、チャンネル、担当者などの構造はパラメータ表を参照してください。 |
| content.extend.text | string | 長さチェックに使用するプレーンテキスト。最大 3000 文字。 |
| content.extend.channels | array<object> |
説明内で参照されるチャンネル。uuid、name、type、exists を含みます。返却時、exists は現在のリソース存在性に基づいて更新されます。 |
| content.extend.channels[].uuid | string | チャンネル UUID。 |
| content.extend.channels[].name | string または null | 表示名。 |
| content.extend.channels[].type | string | チャンネル参照マーカー #。 |
| content.extend.channels[].exists | boolean | 返却時にそのチャンネルが存在するか。 |
| content.extend.members | array<object> |
説明内で @ されたメンバー参照。uuid、name、type、exists を含みます。 |
| content.extend.members[].uuid | string | メンバーアカウント UUID。 |
| content.extend.members[].name | string または null | 表示名。 |
| content.extend.members[].type | string | メンバー参照マーカー @。 |
| content.extend.members[].exists | boolean | 返却時にそのアカウントが存在するか。 |
| content.extend.manager | array<string> |
担当者識別子配列。Issue のみで使用されます。メンバー/チーム/通知先/メールアドレスなどは有効性に基づいて正規化されます。 |
| content.extend.manager[] | string | 単一の担当者識別子。 |
| content.extend.linkList | array<object> |
業務参考リンク。 |
| content.extend.linkList[].name | string | リンクの表示名。 |
| content.extend.linkList[].link | string | 業務 URL。 |
| content.extend.sourceLink | string | ソースページリンク。存在する場合はクライアントが入力します。 |
| content.extend.extra | object | サードパーティ連携の表示情報。API の実際の認証アイデンティティは変更しません。 |
| content.extend.extra.creator | object | サードパーティ作成者の表示情報。name、email を含む場合があります。 |
| content.extend.extra.creator.name | string | 作成者の表示名。 |
| content.extend.extra.creator.email | string | 作成者の表示メールアドレス。 |
| content.extend.extra.updator | object | サードパーティ更新者の表示情報。name、email を含む場合があります。 |
| content.extend.extra.updator.name | string | 更新者の表示名。 |
| content.extend.extra.updator.email | string | 更新者の表示メールアドレス。 |
| content.extend.extra.managerInfos | object | 担当者のメールアドレスをキーとする表示情報マップ。Issue のみで使用されます。 |
| content.extend.extra.managerInfos.邮箱.name | string | 対応するメールアドレス担当者の表示名。 |
| content.extend.其他字段 | JSON | クライアントが保存するその他の拡張情報。すべてが業務動作をトリガーするわけではありません。 |
| content.creatorInfo | object | 作成者表示情報。サードパーティの extend.extra.creator に値がある場合、一部の読み取り API はこの表示情報を優先して使用します。 |
| content.creatorInfo.name | string | 表示名。省略可能。 |
| content.creatorInfo.email | string | メールアドレス。省略可能。 |
| content.creatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.updatorInfo | object | 更新者表示情報。空オブジェクトの場合があります。 |
| content.updatorInfo.name | string | 表示名。省略可能。 |
| content.updatorInfo.email | string | メールアドレス。省略可能。 |
| content.updatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.levelInfo | object | 履歴レベルの表示情報。削除済み、または現在の有効一覧にない旧レベルを含む場合があります。対応する設定がない場合は {} の場合があります。新規書き込みに使用できるかどうかは有効なレベル一覧に基づきます。 |
| content.levelInfo.uuid | string | レベル UUID。Issue.level にまだ使用できるかは、現在の有効なレベル一覧に基づいて判断してください。 |
| content.levelInfo.name | string | レベル名。ワークスペースの言語またはレベル設定に応じて表示されます。 |
| content.levelInfo.color | string | 色文字列。通常は #RRGGBB。 |
| content.levelInfo.description | string | レベル説明。 |
| content.managerInfos | array<object> |
解決後の担当者表示情報。アカウント情報は実際に表示可能なフィールドに応じて返され、チーム/通知先は通常 uuid と name を含み、メールアドレスは uuid/email/name を含みます。 |
| content.managerInfos[].uuid | string | 担当者識別子。 |
| content.managerInfos[].name | string | 表示名。 |
| content.managerInfos[].email | string | メールアドレス担当者またはアカウントのメールアドレス。値がある場合に提供されます。 |
| content.ruleType | string | ソースが checker で、モニター設定が見つかった場合に提供されるタイプ。 |
| content.eventTimeRange | array<integer> |
関連イベント数が存在する場合に提供される開始・終了時間。Unix ミリ秒。 |
| content.eventTimeRange[] | integer | Unix ミリ秒タイムスタンプ。 |
| content.eventConditions | string | 自動検出ソースに有効なルールが存在する場合に提供されるイベントクエリ条件。 |
| content.eventConditionsFilters | JSON | 自動検出ソースのフィルター編集データ。設定がある場合に提供されます。 |
| content.attachments | array<object> |
Issue に関連付け済みの添付ファイル一覧。ダウンロードには 添付ファイルをダウンロード を使用します。 |
| content.attachments[].uuid | string | 添付ファイル UUID。 |
| content.attachments[].fileName | string | 元のファイル名。 |
| content.attachments[].fileSuffix | string | ファイル拡張子。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
| content.creatorInfo.status | integer | アカウントレコードステータス。省略可能。 |
| content.creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能。 |
| content.creatorInfo.username | string | ログイン名。省略可能。 |
| content.creatorInfo.iconUrl | string | アカウントのアバター URL。省略可能。 |
| content.creatorInfo.mobile | string | アカウントの携帯電話番号。空または省略可能。 |
| content.creatorInfo.countryCode | string | 携帯電話番号の国/地域コード。省略可能。 |
| content.creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.updatorInfo.status | integer | アカウントレコードステータス。省略可能。 |
| content.updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能。 |
| content.updatorInfo.username | string | ログイン名。省略可能。 |
| content.updatorInfo.iconUrl | string | アカウントのアバター URL。省略可能。 |
| content.updatorInfo.mobile | string | アカウントの携帯電話番号。空または省略可能。 |
| content.updatorInfo.countryCode | string | 携帯電話番号の国/地域コード。省略可能。 |
| content.updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.managerInfos[].status | integer | アカウントレコードステータス。省略可能。 |
| content.managerInfos[].wsAccountStatus | integer | 現在のワークスペースにおけるアカウントステータス。省略可能。 |
| content.managerInfos[].username | string | ログイン名。省略可能。 |
| content.managerInfos[].iconUrl | string | アカウントのアバター URL。省略可能。 |
| content.managerInfos[].mobile | string | アカウントの携帯電話番号。空または省略可能。 |
| content.managerInfos[].countryCode | string | 携帯電話番号の国/地域コード。省略可能。 |
| content.managerInfos[].acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.levelInfo.id | integer または null | レベルレコード番号。システムデフォルトレベルの場合はこのフィールドは提供されません。 |
| content.levelInfo.workspaceUUID | string | 履歴レベル表示情報の任意フィールド。所属ワークスペース UUID。 |
| content.levelInfo.status | integer | 履歴レベル表示情報の任意フィールド。レコードステータス。0 は正常、3 は削除済み。Issue の業務ステータス statusType とは区別します。 |
| content.levelInfo.creator | string | 履歴レベル表示情報の任意フィールド。作成呼び出しアイデンティティ。API Key 識別子、アカウント、システムアイデンティティの場合があります。 |
| content.levelInfo.updator | string | 履歴レベル表示情報の任意フィールド。最終更新アイデンティティ。未設定の場合は空文字列です。 |
| content.levelInfo.createAt | integer | 履歴レベル表示情報の任意フィールド。作成時間、Unix 秒。 |
| content.levelInfo.updateAt | integer | 履歴レベル表示情報の任意フィールド。最終更新時間、Unix 秒。未更新の場合は -1 の場合があります。 |
| content.levelInfo.deleteAt | integer | 履歴レベル表示情報の任意フィールド。削除時間、Unix 秒。未削除の場合は -1 です。 |
| content.levelInfo.extend | object または null | 履歴レベル表示情報の任意フィールド。作成時に保存された追加 JSON オブジェクト。レベル変更 API は現在このフィールドを変更しません。 |
| content.levelInfo.isManage | boolean または number | 履歴レベル表示情報の任意フィールド。プラットフォーム管理レベルかどうか。ワークスペースで独自に作成した場合は通常 false です。 |
| content.levelInfo.isDefault | boolean | システムデフォルトレベルの表示マーカー。省略可能。 |
{
"code": 200,
"content": {
"id": 101,
"uuid": "issue_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430800,
"deleteAt": -1,
"name": "checkout-api 延迟异常",
"level": "system_level_1",
"statusType": 15,
"statusTypeUpdateRecord": [
"1785430800&&Working"
],
"description": "定位生产接口延迟,记录处理过程。",
"resourceType": "",
"resourceUUID": "",
"resource": "",
"repeatType": "",
"subIdentify": "",
"extend": {},
"resolveAt": -1,
"eventCount": 0,
"eventCountUpdateAt": -1,
"triggerRecord": {},
"creatorInfo": {},
"updatorInfo": {},
"levelInfo": {
"uuid": "system_level_1",
"name": "P1",
"description": "业务重要功能不可用,但影响用户有限。",
"color": "#FF7931",
"isDefault": true
},
"managerInfos": [],
"attachments": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては 共通エラー定義 を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではありません | 一部の json ファイル形式エラー | JSON オブジェクトを送信します。 |
| 404 | ft.ObjectNotExists | 指定リソースが現在のワークスペースに存在しないか、クエリ条件に一致しません | 指定オブジェクトが存在しません | 同じワークスペースのリソース UUID を再取得し、削除済みでないか確認します。 |
| 406 | ft.IssueLevelNotExists | level が現在のワークスペースの有効なレベル集合に属していません | レベル設定が存在しません | 先に 有効なレベル一覧 をクエリし、返された uuid を取得します。レベルを設定しない場合は、パラメータ説明に従って空文字列を送信できます。 |
| 406 | ft.ExceedMaxLengthLimit | extend.text の長さが 3000 文字を超えています | テキストの最大長制限を超過 | プレーンテキストフィールドを短縮します。長い診断資料は添付ファイルとしてアップロードします。 |
| 400 | ft.UnsupportFreeIssueManager | 制限付きワークスペースプランで、ワークスペース外のメールアドレスを担当者として使用しています | 無料プランのワークスペースでは、インシデントの担当者に外部メールアドレスを使用できません | ワークスペースのメンバーを選択するか、プランが外部メールアドレス担当者をサポートしているか確認します。 |
| 500 | ft.InternalServerError | レベルまたは設定の保存、監査、その他の内部処理に失敗しました | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認してから再試行を判断します。継続的に失敗する場合は traceId を提供してください。 |