取得¶
GET /api/v1/issue/{issue_uuid}/get
概要¶
現在のワークスペースにある単一 Issue の詳細、担当者、レベル、チャンネル、添付ファイル情報を取得します。
呼び出し前の確認と使用手順¶
Issue 一覧または作成結果から uuid を取得し、パスに設定します。レスポンスには保存済みの説明と extend、表示情報、添付ファイル識別子が含まれます。返された uuid を使用して更新や返信を続行できます。操作は現在の API Key が属するワークスペースを使用します。リソース識別子は同じワークスペースから取得してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を取得します。 |
パラメータ補足¶
返された extend を読み取ってから変更を実行すると、引き続き使用する担当者、リンク、表示情報を保持できます。添付ファイルのダウンロードには添付ファイル UUID を使用し、Issue UUID は使用しません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/issue/issue_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
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 識別子、アカウント、システム ID のいずれかです。 |
| 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 の実際の認証 ID は変更しません。 |
| 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.bindChannels | array<object> |
Issue にバインドされたチャンネル。 |
| content.bindChannels[].uuid | string | チャンネル UUID。 |
| content.bindChannels[].name | 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 識別子、アカウント、システム ID のいずれかです。 |
| 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": 10,
"statusTypeUpdateRecord": [],
"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": [],
"bindChannels": [
{
"uuid": "chan_example",
"name": "生产异常"
}
],
"attachments": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundIsuue | Issue が存在しない、削除済み、または現在のワークスペースに属していない | 指定された Issue が見つかりません | Issue 一覧を使用して有効な uuid を再取得してください。エラーコードの綴りは Isuue のまま保持されることに注意してください。 |