APIガイド
コレクター GraphQL API
Time
説明 : 'Time' は RFC3339 標準に準拠したタイムスタンプを表します
Map
Any
PromVector
説明 : 'PromVector' は、以下のリンクで確認できる Prometheus API の型と1対1で対応するカスタムスカラーです。
PromSample
説明 : 'PromSample' は、以下のリンクで確認できる Prometheus API の型と1対1で対応するカスタムスカラーです。
PromMatrix
説明 : 'PromMatrix' は、上記 'Vector' のリンクで詳細を確認できる Prometheus API の型と1対1で対応するカスタムスカラーです。
Hosts
説明 : 'Hosts' は、'key' がIPアドレス、'value' が関連付けられたホスト名のリストとなるマップ型を表すカスタムスカラーです
KubernetesConfig
説明 : 'KubernetesConfig' は、任意の YAML 形式の Kubernetes 設定を表すカスタムスカラーです
StringSlice
EmailAddress
説明 : EmailAddress は 'foo@bar.com' または ' foo@bar.com' 形式でなければならない文字列型です
NetworkCIDR
説明 : NetworkCIDR は、標準的な '192.0.2.0/24' CIDR 形式でなければならない文字列型です
EndpointCredentials
DeploymentStatus
説明 : 'DeploymentStatus' は helm ステータスの列挙型を表すカスタムスカラーです
ChartStatus
説明 : 'ChartStatus' は、チャート名、バージョン、ステータスに関連付けられた異なるキーを持つチャートステータス値を保持するマップを表すカスタムスカラーです
Uint
説明 : Uint は Int の 32 または 64 ビットの符号なし対応型です
Proxy
説明 : 'proxy' はネットワークプロキシ値として使用される文字列値を表すカスタムスカラーです。
ConfigStatus
RBACObject
RBACAction
Query
説明 : Prometheus エンドポイントのクエリ
フィールド
フィールド
型
説明
引数
node Node
id: ID
getCluster Cluster
IDでクラスタを取得
clusterID: ID
getClusterBacklogCount ClusterNodeTimeSeries
clusterID: ID, timeRange: TimeRange
getClusterBacklogAge ClusterNodeTimeSeries
clusterID: ID, timeRange: TimeRange
getClusterTransmitBytes ClusterNodeTimeSeries
clusterID: ID, timeRange: TimeRange
getClusterReceiveBytes ClusterNodeTimeSeries
clusterID: ID, timeRange: TimeRange
getClustersByIDs Cluster
複数IDでクラスタを取得
clusterIDs: ID
getClusterNode ClusterNode
clusterID: ID, clusterNodeInput: ClusterNodeInput
getAllClusters Cluster
テナント上でプロビジョニングされたすべてのクラスタを取得
role: String
getClusterConfig KubernetesConfig
クラスタの設定を取得
clusterID: ID
getClusterImageV2 Image
クラスタのイメージダウンロードリンクを取得
input: ClusterImageInput
getClusterImage Image
非推奨。統合入力用に getClusterImageV2 を使用してください。
clusterID: ID, imageType: ImageType, launchConsole: Boolean, awsDetails: AWSDetails, gcpDetails: GCPDetails
getCloudZones CloudRegion
クラウドサービスのリージョンとゾーンを取得
imageType: ImageType
getClusterCredentials Credentials
クラスタの認証情報を取得
clusterID: ID
getHosts Hosts
指定したクラスタに関連付けられたすべての host->address マッピングを取得
clusterID: ID
getClusterActivationDetails Activation
clusterID: ID
getSystemByRole System
role: String
getOSConfig OSConfig
clusterID: ID, nodeName: String
getAllOSConfigs OSConfig
clusterID: ID
getClusterStatuses Status
クラスタのステータスおよびデプロイ済み helm リソースを取得
clusterID: ID
getClusterDeploymentStatus ChartStatus
クラスタデプロイメントのステータスを取得
clusterID: ID, deploymentID: ID
getChart Chart
名前で単一の Helm チャートを取得
chartName: String
getAllCharts ChartList
デプロイ可能なすべての Helm チャートを取得
getBillOfMaterials BillOfMaterials
getClusterDeployment Deployment
コレクター配下の単一デプロイメントを取得
clusterID: ID, deploymentID: ID
getAllClusterDeployments Deployment
コレクター配下のすべてのデプロイメントを取得
clusterID: ID
getDeploymentEndpoint Endpoint
指定したデプロイメントに設定されたエンドポイントを取得
clusterID: ID, deploymentID: ID, endpointID: ID
getAllDeploymentEndpoints Endpoint
指定したデプロイメントに設定されたすべてのエンドポイントを取得
clusterID: ID, deploymentID: ID
getDeploymentEndpointCredentialsValidityPeriod ValidityPeriod
EndpointCredential の有効期間を取得
clusterID: ID, deploymentID: ID, endpointID: ID
getAWSRegions String
利用可能なイメージがある AWS リージョンのリストを取得
getRoleDeployments Deployment
指定したロールのすべてのクラスタにインストールされるデプロイメントを取得
role: String
getRoleDeployment Deployment
IDでロールベースのデプロイメントを取得
deploymentID: ID
getAllCollectorsOverview CollectorOverview
指定したロールと期間のすべてのコレクター概要データを取得
role: String, timeRange: TimeRange
getCollectorMetrics CollectorMetrics
指定した期間のコレクターデータフローメトリクスを取得
timeRange: TimeRange
getAggregateRateByCollector AggregateRateByCollector
指定したコレクターの指定期間の集計データフローレートメトリクスを取得
clusterID: ID, timeRange: TimeRange
getFlowRate FlowRate
指定したコレクターの指定期間のフローレートメトリクスを取得
clusterID: ID, timeRange: TimeRange
getLogLastSeenMetrics LogLastSeenMetrics
指定したクラスタのすべての利用可能なログソースの最終確認メトリクスを取得。
clusterID: ID
getDataSourceMetrics DataSourceMetrics
指定したクラスタのすべての利用可能なデータソースのメトリクスを取得
in: GetDataSourceMetricsArguments
syslogMessageCountV2 SyslogMessageCountV2
指定したクラスタまたはデータソースの syslog メッセージ数を取得
in: SyslogMessageCountV2Arguments
getScheduledService ScheduledService
ID: String
getClustersPasswordHash String
クラスタのパスワードハッシュを取得
clusterID: ID
getDataCollectors DataCollectorResult
Data collectors cql スキーマの検索および集計
input: QlQueryInput
ID
説明 : ID スカラー型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID 型は JSON レスポンスでは文字列として現れますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列（例: "4"）や整数（例: 4）が ID として受け入れられます。
String
説明 : String スカラー型はテキストデータを表し、UTF-8 文字列として表現されます。String 型は GraphQL で自由形式の人間が読めるテキストを表すためによく使われます。
Boolean
説明 : Boolean スカラー型は true または false を表します。
Mutation
フィールド
フィールド
型
説明
引数
createCluster Cluster
指定したロールの新しいクラスタを作成
clusterInput: ClusterInput
createHAClusterStaticConfig Cluster
clusterNodes に静的IPを含むクラスタを作成
clusterInput: HAStaticClusterInput
updateCluster Cluster
クラスタを更新
clusterID: ID, clusterInput: ClusterInput
deleteCluster Deleted
クラスタを削除
clusterID: ID
createOSConfig OSConfig
input: OSConfigInput
updateOSConfig OSConfig
input: OSConfigInput
deleteOSConfig String
clusterID: ID, nodeName: String
addHost Hosts
指定したクラスタに address:hostname マッピングを追加
clusterID: ID, hostInput: HostsInput
deleteHost Deleted
指定したクラスタから IP アドレスと関連ホスト名を指定して address:hostname マッピングを削除
clusterID: ID, address: String
createClusterStatus Status
指定したクラスタの初期デプロイメントステータスを作成
clusterID: ID, statusInput: StatusInput
updateClusterStatus Status
指定したクラスタのデプロイメントステータスを更新
clusterID: ID, statusInput: StatusInput
deleteClusterStatus Deleted
指定したクラスタのデプロイメントステータスを削除
clusterID: ID, deploymentID: ID
createClusterDeployment Deployment
指定したクラスタにローカルデプロイメントを作成
clusterID: ID, deploymentInput: DeploymentInput
updateClusterDeployment Deployment
非推奨。updateClusterDeploymentV2 を使用してください
clusterID: ID, deploymentID: ID, deploymentInput: DeploymentInput
updateClusterDeploymentV2 Deployment
指定したクラスタのデプロイメントをバージョン2で更新
clusterID: ID, deploymentID: ID, updateDeploymentInput: UpdateDeploymentInput
deleteClusterDeployment Deleted
指定したクラスタのデプロイメントを削除
clusterID: ID, deploymentID: ID
createEndpoint Endpoint
指定したクラスタのエンドポイントを作成
clusterID: ID, deploymentID: ID, endpointInput: EndpointInput
updateEndpoint Endpoint
指定したクラスタのエンドポイントを更新
clusterID: ID, deploymentID: ID, endpointID: ID, endpointInput: EndpointInput
deleteEndpoint Deleted
指定したクラスタのエンドポイントを削除
clusterID: ID, deploymentID: ID, endpointID: ID
createRoleDeployment Deployment
指定したロールのすべてのクラスタにインストールされるデプロイメントを作成。Secureworks 管理者のみがこのエンドポイントにアクセス可能。
role: String, deploymentInput: DeploymentInput
updateRoleDeployment Deployment
IDでシステムデプロイメントを更新。Secureworks 管理者のみがこのエンドポイントにアクセス可能。
deploymentID: ID, deploymentInput: DeploymentInput
deleteRoleDeployment Deleted
IDでシステムデプロイメントを削除。Secureworks 管理者のみがこのエンドポイントにアクセス可能。
deploymentID: ID
updateScheduledService ScheduledService
scheduledServiceInput: ScheduledServiceInput
createService Service
serviceInput: CreateServiceInput
Node
フィールド
ClusterNode
フィールド
フィールド
型
説明
引数
createdAt Time
updatedAt Time
id ID
name String
description String
network Network
health String
registration Registration
host String
Cluster
説明 : クラスタ構造体はデータコレクターのアトリビュートを表します
フィールド
フィールド
型
説明
引数
createdAt Time
updatedAt Time
id ID
role String
name String
type String
clusterType ClusterType
description String
network Network
deployments Deployment
status Status
health String
healthState String
registration Registration
maintenanceDay DayType
maintenanceStartHour Int
maintenanceDuration Int
clusterNodes ClusterNode
isHa Boolean
haCidrBlock String
serviceTrack ServiceTrack
partnerTenantName String
Int
説明 : Int スカラー型は符号付きの非小数整数値を表します。Int は -(2^31) から 2^31 - 1 までの値を表現できます。
CloudRegion
フィールド
フィールド
型
説明
引数
region String
zones String
Service
フィールド
フィールド
型
説明
引数
id ID
createdAt Time
updatedAt Time
upgradeVersion String
installFile String
verificationFile String
name String
reboot Boolean
ScheduledService
フィールド
フィールド
型
説明
引数
id ID
createdAt Time
updatedAt Time
status String
clientStatus String
clusterNodeID ID
clusterID String
deferred Boolean
service Service
endDate Time
startDate Time
retries Int
ServiceTrack
フィールド
フィールド
型
説明
引数
scheduledServices ScheduledService
serviceHistories ServiceHistory
ServiceHistory
フィールド
フィールド
型
説明
引数
id ID
createdAt Time
updatedAt Time
name String
startDate Time
endDate Time
clusterNodeID ID
clusterID String
serviceID ID
status String
upgradeVersion String
フィールド
フィールド
型
説明
引数
ID ID
clusterNodeID ID
status String
retries Int
フィールド
フィールド
型
説明
引数
id ID
clusterNodeID ID
deferred Boolean
serviceID ID
startDate Time
endDate Time
フィールド
フィールド
型
説明
引数
name String
upgradeVersion String
installFile String
verificationFile String
reboot Boolean
deleteSchedule Boolean
OSConfig
フィールド
フィールド
型
説明
引数
createdAt Time
updatedAt Time
clusterID ID
nodeName String
status ConfigStatus
statusMessage String
dhcp Boolean
hostname String
hosts Hosts
address String
mask String
gateway String
dns StringSlice
ntp StringSlice
proxy Proxy
フィールド
フィールド
型
説明
引数
clusterID ID
nodeName String
status ConfigStatus
statusMessage String
dhcp Boolean
hostname String
hosts HostsInput
address String
mask String
gateway String
dns String
ntp String
proxy Proxy
Activation
フィールド
フィールド
型
説明
引数
code String
id String
region String
CollectorOverview
説明 : CollectorOverview は、Cluster とそれに対応する lastSeen および averageRate メトリクスを組み合わせたものです。
フィールド
フィールド
型
説明
引数
cluster Cluster
lastSeen PromSample
averageRate PromSample
説明 : ClusterInput はクラスタオブジェクトに対応する入力型です。
フィールド
フィールド
型
説明
引数
name String
description String
network NetworkInput
role String
clusterType ClusterType
registration RegistrationInput
maintenance MaintenanceInput
clusterNodes ClusterNodeInput
isHa Boolean
haCidrBlock String
haCidrBlockArray String
scheduledServices ClusterScheduledServiceInput
説明 : ClusterInput はクラスタオブジェクトに対応する入力型です。
フィールド
フィールド
型
説明
引数
name String
description String
network NetworkInput
role String
clusterType ClusterType
registration RegistrationInput
maintenance MaintenanceInput
clusterNodes ClusterNodeInput
haCidrBlock String
haCidrBlockArray String
MaintenanceInput
説明 : クラスタオブジェクトのメンテナンスウィンドウを設定するための入力。期間は時間単位で指定
フィールド
フィールド
型
説明
引数
day DayType
startHour Int
duration Int
DayType
説明 : DayType はメンテナンスを実施可能な利用可能日・サポート日を保持します
説明 : ClusterInput はクラスタオブジェクトに対応する入力型です。
フィールド
フィールド
型
説明
引数
name String
description String
network NetworkInput
registration RegistrationInput
host String
説明 : ダウンロードするクラスタイメージを特定するための入力
フィールド
フィールド
型
説明
引数
clusterID ID
imageType ImageType
launchConsole Boolean
awsDetails AWSDetailsV2
gcpDetails GCPDetailsV2
Deleted
説明 : Deleted は任意のオブジェクト削除アクションに関連するメタデータを含む構造体です
フィールド
フィールド
型
説明
引数
type String
id String
successful Boolean
Deployment
説明 : Deployment は helm パッケージと設定を定義します
フィールド
フィールド
型
説明
引数
createdAt Time
updatedAt Time
id ID
role String
name String
description String
chart String
version String
config Map
status Status
endpoints Endpoint
alertable Boolean
説明 : DeploymentInput はデプロイメントオブジェクトに対応する入力型です
フィールド
フィールド
型
説明
引数
name String
description String
chart String
version String
config Map
endpoints EndpointInput
alertable Boolean
説明 : UpdateDeploymentInput はデプロイメントオブジェクトの更新に対応する入力型です
フィールド
フィールド
型
説明
引数
name String
description String
version String
config Map
alertable Boolean
Endpoint
説明 : Endpoint はアプリケーションがデータを収集するための API エンドポイントと認証情報を定義します
フィールド
フィールド
型
説明
引数
createdAt Time
updatedAt Time
id ID
description String
address String
port Int
validity ValidityPeriod
credentials EndpointCredentials
説明 : EndpointInput はエンドポイントオブジェクトに対応する入力型です
フィールド
フィールド
型
説明
引数
description String
address String
port Int
credentials EndpointCredentials
ValidityPeriod
フィールド
フィールド
型
説明
引数
from Uint
until Uint
Image
説明 : Image は、指定したクラスタのイメージメタデータ（イメージダウンロードリンクなど）を含むオブジェクトを表します
フィールド
フィールド
型
説明
引数
location String
Registration
説明 : Registration は、指定したクラスタの SSM ID およびリージョン情報を含むオブジェクトを表します
フィールド
フィールド
型
説明
引数
id ID
region String
説明 : RegistrationInput は registration オブジェクトに対応する入力型です
フィールド
フィールド
型
説明
引数
id ID
region String
Network
説明 : ネットワーク構造体は、指定したデータコレクターのネットワーク設定アトリビュートを表します
フィールド
フィールド
型
説明
引数
dhcp Boolean
hostname String
hosts Hosts
address String
mask String
gateway String
dns StringSlice
ntp StringSlice
proxy Proxy
説明 : NetworkInput はネットワークオブジェクトに対応する入力型です
フィールド
フィールド
型
説明
引数
dhcp Boolean
hostname String
hosts HostsInput
address String
mask String
gateway String
dns String
ntp String
proxy Proxy
説明 : hosts 入力構造体は、データコレクターで使用される IPアドレス→ホスト名のマッピングセットを表します。
フィールド
フィールド
型
説明
引数
address String
hostname String
Status
説明 : ステータス構造体は、コレクター自身のデプロイメントに関する正常性および準備状況の概要を表します
フィールド
フィールド
型
説明
引数
name String
createdAt Time
updatedAt Time
id ID
status ChartStatus
説明 : StatusInput はステータスオブジェクトに対応する入力型です
フィールド
フィールド
型
説明
引数
deploymentID String
name String
status ChartStatus
System
フィールド
フィールド
型
説明
引数
updatedAt Time
id Int
deployments Deployment
ChartList
説明 : chart list 構造体は、リポジトリでインストール可能な 'helm chart' エントリのリストを表します
フィールド
フィールド
型
説明
引数
APIVersion String
Entries Any
Generated Time
Chart
説明 : chart 構造体は、指定した helm chart に関連付けられたアトリビュートを表します
フィールド
フィールド
型
説明
引数
apiVersion String
appVersion String
name String
description String
icon String
home String
keywords String
annotations Map
version String
digest String
urls String
metaData Any
BillOfMaterials
フィールド
フィールド
型
説明
引数
location String
Credentials
説明 : credentials 構造体は、指定したコレクターのローカルアクセスに関する認証情報アトリビュートのセットを表します
フィールド
フィールド
型
説明
引数
password String
passwordHash String
privateKey String
publicKey String
passwordHistory PasswordHistory
setDate Time
PasswordHistory
フィールド
フィールド
型
説明
引数
password String
passwordHash String
setDate Time
PasswordHistoryInput
フィールド
フィールド
型
説明
引数
password String
passwordHash String
setDate Time
説明 : credentialsInput 構造体は、指定したコレクターのローカルアクセスに関する認証情報アトリビュートのセットを表します
フィールド
フィールド
型
説明
引数
password String
passwordHash String
privateKey String
publicKey String
passwordHistory PasswordHistoryInput
setDate Time
CollectorMetrics
説明 : collector metrics 構造体は、コレクターデータメトリクスのセットを表します
フィールド
フィールド
型
説明
引数
lastSeen PromVector
このフィールドを選択すると、max(collector_last_seen) by (collector) とほぼ同等の値が得られます
averageRate PromVector
このフィールドを選択すると、avg(rate(collector_conversation_bytes[TimeRange])) by (collector) とほぼ同等の値が得られます
AggregateRateByCollector
説明 : aggregate rate metrics 構造体は、集計されたコレクターデータフローレートメトリクスのセットを表します
フィールド
フィールド
型
説明
引数
aggregateRate PromMatrix
このフィールドを選択すると、sum(rate(collector_conversation_bytes[TimeRange]))[TimeRange] とほぼ同等の値が得られます
ClusterNodeTimeSeries
フィールド
フィールド
型
説明
引数
clusterID String
tenant String
nodeId String
nodeName String
ipAddress String
val TimeSeries
TimeSeries
フィールド
フィールド
型
説明
引数
time String
unixTime Int
value String
FlowRate
説明 : aggregate flow rate metrics 構造体は、コレクターデータフローレートメトリクスのセットを表します。
フィールド
フィールド
型
説明
引数
perFlowMax PromVector
このフィールドを選択すると、max(collector_last_seen) by (src_host,dst_host,dst_port,host_addr,src_dns,proto) とほぼ同等の値が得られます
perFlowAverage PromVector
このフィールドを選択すると、avg(rate(collector_conversation_bytes[TimeRange])) by (src_host,dst_host,dst_port,host_addr,src_dns,proto) とほぼ同等の値が得られます
LogLastSeenMetrics
説明 : LogLastSeenMetrics は、指定したコレクターのすべての記録済みログソースのログ正常性データを保持します
フィールド
フィールド
型
説明
引数
logMetrics LogLastSeenMetric
DataSourceMetrics
説明 : DataSourceMetrics は、指定したコレクターのすべての記録済みログソースのログ正常性データを保持します
フィールド
フィールド
型
説明
引数
metrics DataSourceMetric
LogLastSeenMetric
説明 : LogLastSeenMetric は、ログソースを特定するためのすべての関連メタデータと 'lastSeen' タイムスタンプを含みます。
フィールド
フィールド
型
説明
引数
clusterID ID
clusterName String
sourceID String
aliases String
service String
sensorType String
lastSeen Time
health String
DataSourceMetric
説明 : DataSourceMetric は、ログソースを特定するためのすべての関連メタデータと 'lastSeen' タイムスタンプを含みます。
フィールド
フィールド
型
説明
引数
clusterID ID
clusterName String
sourceID String
aliases String
service String
sensorTypes String
lastSeen Time
health String
SyslogMessageCountV2
フィールド
フィールド
型
説明
引数
sourceID String
schema String
sensorTypes String
services String
collectors String
count Uint
AWSDetails
説明 : awsDetails 入力型は AWS イメージダウンロードで使用するために必要な識別情報を含みます。
フィールド
フィールド
型
説明
引数
accountID ID
region String
AWSDetailsV2
説明 : awsDetails 入力型は AWS イメージダウンロードで使用するために必要な識別情報を含みます。
フィールド
フィールド
型
説明
引数
accountID Uint
region String
GCPDetails
説明 : gcpDetails 入力型は GCP イメージダウンロードで使用するために必要な識別情報を含みます。
フィールド
フィールド
型
説明
引数
agentId String
cidr String
gcpProject String
network String
region String
subnet String
zone String
GCPDetailsV2
説明 : gcpDetails 入力型は GCP イメージダウンロードで使用するために必要な識別情報を含みます。
フィールド
フィールド
型
説明
引数
agentId EmailAddress
cidr NetworkCIDR
gcpProject String
network String
region String
subnet String
zone String
GetDataSourceMetricsArguments
説明 : GetDataSourceMetricsArguments は GetDataSourceMetrics 呼び出し時にフィルター引数を指定できます。
フィールド
フィールド
型
説明
引数
clusterId ID
sourceId ID
SyslogMessageCountV2Arguments
フィールド
フィールド
型
説明
引数
sourceId ID
clusterId ID
TimeRange
説明 : TimeRange は prometheus クエリエンドポイントで受け入れられる利用可能な時間範囲の列挙型です
ClusterType
説明 : ClusterType は、クラスタがオンプレミスかクラウドホストかを表す利用可能なクラスタタイプの列挙型です
ImageType
説明 : ImageType は、利用可能かつサポートされているコレクターイメージタイプの列挙型です
DataCollector
説明 : Datacollector 構造体は、CQL クエリのカスタムウィジェットで使用できるデータコレクターのアトリビュートを表します
フィールド
フィールド
型
説明
引数
id ID
name String
type String
nodes NodeInfo
applications Deployment
collectorHealth String
isHa Boolean
tenant ID
NodeInfo
フィールド
フィールド
型
説明
引数
network Network
nodeHealth String
DataCollectorResult
フィールド
フィールド
型
説明
引数
dataCollectors DataCollector
aggregation Map
pagination QLPageCursor
検索クエリのみ利用可能。assets 結果セットのページネーション情報を記述
フィールド
フィールド
型
説明
引数
cqlQuery String
cursor String
検索クエリのみ。ページを表すカーソル。base64 エンコードされた '{offset} {count}' テンプレート。通常は前回リクエストからこの値を取得します。（previousCursor, nextCursor）
count Int
カーソル以降（正の数）または以前（負の数）に何件返すか。ページサイズの設定や変更が可能。検索クエリにのみ適用
QLPageCursor
説明 : QLPageCursor は、ページごとに結果をナビゲートするために使用できるカーソル情報を記述します。previousCursor および nextCursor をオプションで返すことで、さらなる結果があることを示します。
フィールド
フィールド
型
説明
引数
nextCursor String
次ページのカーソル。末尾の場合は null
previousCursor String
前ページのカーソル。先頭の場合は null
cursor String
現在ページのカーソル
count Int
このページで返されるレコード数
totalCount Int
指定した検索条件で利用可能なレコード総数