Datasources GraphQL API

注意

2026年2月3日をもって、現在のv1 DataSource Assets APIクエリ（クエリのみ、ミューテーションは対象外）は非推奨となります。

新しいv2 APIでは、フィルタリングやページネーションなどの高度な機能が追加され、大量のレポートソースを管理するテナント向けに大幅なパフォーマンス向上が実現されます。

v2のフィルタリング機能にはsourceIdSearchフィールドが追加されており、部分一致のための文字列リストを受け付けることで、より細かなフィルタリングが可能です。これは、完全一致を行うsourceIdフィールドとは異なります。

新しいデータソースページおよびv2実装によって返されるデータは、いずれも最終的な整合性（eventual consistency）であることに注意してください。そのため、アセットの削除などのアクションがページやgetDataSourceLastSeenAssetsV2クエリの結果に即座に反映されない場合があります。

AuthzObject

説明: AuthzObjectは、アプリケーションへの正しい認可に必要なすべてのオブジェクトを列挙します

AuthzAction

説明: AuthzObjectは、指定されたオブジェクトに対して許可されるすべてのアクションを列挙します

Node

フィールド

フィールド	型	説明	引数
id	ID

ID

説明: IDスカラ型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID型はJSONレスポンスでは文字列として表示されますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列（例: "4"）や整数（例: 4）がIDとして受け入れられます。

LastSeenAsset

説明: LastSeenAsset型は、特定のコレクターに関する正常性の状態情報に関連するデータセットを定義します

フィールド

フィールド	型	説明	引数
sourceId	ID
service	String
sensorType	String
collectorID	ID
lastSeen	Int
health	HealthState
collector	ClusterIdentity
tenantID	String

String

説明: Stringスカラ型はテキストデータを表し、UTF-8文字列として表現されます。String型は、GraphQLで自由形式の人間が読めるテキストを表すためによく使用されます。

Int

説明: Intスカラ型は、小数点を含まない符号付き整数値を表します。Intは-(2^31)から2^31 - 1までの値を表現できます。

HealthState

説明: HealthStateは、特定のインスタンスが最後に確認された時刻に基づいてコレクターに与えられる状態のセットです。

FilterCriteria

説明: Facetは、最終確認時刻に基づいてデータソースをフィルタリングするために使用できるフィールドのセットです。

DeletedAsset

説明: DeletedAsset型は、データソースの削除アクションに関連するメタデータを含む構造体です

フィールド

フィールド	型	説明	引数
sourceId	ID
collectorID	ID
successful	Boolean

Boolean

説明: Booleanスカラ型はtrueまたはfalseを表します。

DeleteAssetInput

説明: アセット削除に必要な入力を定義します。
sourceIdとcollectorIdの両方のフィールドが、削除対象のアセットを正確に指定するために必要です。
対応するミューテーションは、1つ以上のアセットのリストを受け付けます。

フィールド

フィールド	型	説明	引数
sourceId	ID
collectorId	ID

GetDataSourceInput

説明: 特定のデータソースを取得するために必要なパラメータを指定します。
sourceId、collectorId、またはその両方を使用してデータソースをフィルタリングできます。
いずれも指定しない場合は、特定のテナントに関連付けられたすべてのデータソースが返されます。

フィールド

フィールド	型	説明	引数
collectorId	ID
sourceId	ID

PageInfo

説明: 前方および後方のページネーションをサポートするためのフィールドを記述します。

APIはデフォルトで前方ページネーションを使用します。前方と後方のページネーション引数を混在させて送信することは避けてください。
前方と後方のページネーション引数が混在している場合、後方ページネーションに関する引数は無視され、前方ページネーションに関連する引数のみが使用されます。

フィールド

フィールド	型	説明	引数
endCursor	String	前方ページネーションをサポートするためにafterに渡されます。
startCursor	String	後方ページネーションをサポートするためにbeforeに渡されます。
hasNextPage	Boolean	前方ページネーション中に、さらに取得すべき結果があるかどうかを判定するために使用されます。 後方ページネーションを使用している場合、たとえ以前に取得したページに結果があっても、これはfalseになります。
hasPreviousPage	Boolean	後方ページネーション中に、さらに取得すべき結果があるかどうかを判定するために使用されます。 前方ページネーションを使用している場合、たとえ以前に表示したページに結果があっても、これはfalseになります。

QLPageCursor

説明: QLPageCursorは、ページごとに結果をナビゲートするために使用できるカーソル情報を記述します。
PageInfoとの主な違いは、ブール値の代わりにpreviousCursorとnextCursorをオプションで返すことで、さらに結果があることを示す点です。

このオブジェクトはまた、合計件数と現在のページ件数も返し、UIでのロジックを簡素化します。

フィールド

フィールド	型	説明	引数
nextCursor	String	次のページのカーソル（存在する場合）。結果セットの末尾にいる場合はnullになります
previousCursor	String	前のページのカーソル（存在する場合）。結果セットの先頭にいる場合はnullになります
cursor	String	現在のページのカーソル。
count	Int	このページで返されているレコード数
totalCount	Int	指定された検索条件で利用可能なレコードの総数

DataSourceAssetsFilter

説明: DataSourceAssetFilterは、データソース情報をクエリする際に特定の条件でフィルタリングするために使用されます。
CollectorIdは、特定のコレクターのIDに基づいてデータソースをフィルタリングするためにクライアントが使用できます。
SourceIdは、特定のソースのIDに基づいてデータソースをフィルタリングするためにクライアントが使用できます。
Statusは、クライアントがデータソースをフィルタリングするための正常性の状態リストを指定できます。
Whereは、データソースのフィルタリングをサポートするフィールドを提供します。

フィールド

フィールド	型	説明	引数
status	[HealthState]
where	DataSourcesWhereInput

DataSourcesWhereInput

説明: データソースのフィルタリングをサポートするフィールドを記述します。
クエリの動作は、フィルタ条件の値リストを論理ORとして使用し、異なるフィルタ条件タイプが複数指定された場合は論理ANDとしてグループ化されます。

フィールド

フィールド	型	説明	引数
sourceId	[String]
type	[String]
sensorType	[String]
collectorId	[String]
sourceIdSearch	[String]

LastSeenQueryInput

説明: アセットの最終確認データをクエリした結果を表します。CQLクエリが検索の場合はオプションの'assets'リストを含み、集計クエリの場合は'aggregations'マップを含みます。

フィールド

フィールド	型	説明	引数
ql	String	CQL文字列。例: FROM datasources WHERE ...
cursor	String	検索クエリのみ。返すページを表すカーソルで、base64エンコードされた'{offset} {count}'テンプレート。通常は前回のリクエスト（previousCursor, nextCursor）からこの値を取得します。
count	Int	カーソル以降（正の数）または以前（負の数）に返すレコード数。これによりページサイズの設定や変更が可能です。検索クエリにのみ適用されます

LastSeenAssetsSort

説明: データソースの並び順をサポートするフィールドを提供します。

LastSeenAssets

説明: getDataSourceLastSeenAssetsV2をクエリした際に返される型で、アセットのリストと前方・後方ページネーションをサポートするpageInfoを含みます。

フィールド

フィールド	型	説明	引数
assets	[LastSeenAsset]
totalCount	Int
pageInfo	PageInfo

LastSeenAssetsQueryResult

説明: アセットの最終確認データをクエリした結果を表します。CQLクエリが検索の場合はオプションの'assets'リストを含み、集計クエリの場合は'aggregations'マップを含みます。

フィールド

フィールド	型	説明	引数
assets	[LastSeenAsset]	最終確認アセットのリストを含みます。使用したQLが検索クエリ（集計なし）の場合に設定されます
pagination	QLPageCursor	検索クエリのみ利用可能で、アセット結果セットのページネーション情報を記述します
aggregations	[Map!]	提供されたQLが集計結果となる場合、このマップに結果が格納され、'assets'の代わりに返されます

FilterValueResponse

説明: FilterValueResponseは、FilterValueまたはClusterIdentityのいずれかとなるユニオン型です。

FilterValue

説明: FilterValueは、指定されたFilterCriteriaに対する単一の値を含みます

フィールド

フィールド	型	説明	引数
value	String

ClusterIdentity

説明: ClusterIdentityは、クラスター（実質的にはコレクター）のIDと名前を含む型です。
このAPIの文脈では、特定のソースが関連付けられているコレクターを表すために使用されます。

フィールド

フィールド	型	説明	引数
id	ID
name	String

FilterValues

説明: FilterValuesは、指定されたFilterCriteriaに対する値を提供するために使用される戻り値型です

フィールド

フィールド	型	説明	引数
filter	FilterCriteria
values	[FilterValueResponse!]!

Query

フィールド

フィールド	型	説明	引数
getDataSourceLastSeenAsset	LastSeenAsset	入力パラメータに基づき、テナントに関連付けられたすべてのデータソースの最終確認データを取得します。 collectorIdおよびsourceIdによるデータのフィルタリングが可能です。collectorオブジェクトへの読み取り権限が必要です。	input: GetDataSourceInput
getDataSourceLastSeenAssetsV2	LastSeenAssets	入力パラメータに基づき、テナントに関連付けられたすべてのデータソースの最終確認データを取得します。 collectorIdおよびsourceIdによるデータのフィルタリングが可能です。このクエリで返されるデータは最終的な整合性（eventual consistency）です。そのため、アセットの削除などのアクションが結果セットに即座に反映されない場合があります。collectorオブジェクトへの読み取り権限が必要です。 また、前方・後方ページネーションもサポートします。	first: Int, last: Int, after: String, before: String, filter: DataSourceAssetsFilter, sort: LastSeenAssetsSort
getDataSourceLastSeenAssetFilterValues	FilterValues	クライアントが指定したフィルタ条件に対して、利用可能な値を取得する機能を提供します。 一意の値が返され、列挙型の場合はデータセットで観測されたもののみが返されます。	input: FilterCriteria
dataSourceLastSeenAssetsQuery	LastSeenAssetsQueryResult	CQLを使用してアセットの最終確認データをクエリできます	input: LastSeenQueryInput

Mutation

フィールド

フィールド	型	説明	引数
deleteDataSourceAssets	DeletedAsset	指定されたテナントのすべての対象データソースに対して削除操作を実行します。 削除されたすべてのアセットのメタデータ付き配列を返します。collectorオブジェクトへの削除権限が必要です。	deleteAssetInput: DeleteAssetInput

Map