API リファレンス

第1章 Administration Event Service
リンクのコピー

1.1. Administration Event Service
リンクのコピー

1.1.1. CountAdministrationEvents
リンクのコピー

GET /v1/count/administration/events

CountAdministrationEvents は、要求されたフィールドでフィルタリングした後のイベントの数を返します。

1.1.1.1. 説明
リンクのコピー

1.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
filter.from	特定のタイムスタンプ (下限) より後の last_occurred_at が含まれるイベントを特定します。	-	null
filter.until	特定のタイムスタンプ (上限) より前の last_occurred_at が含まれるイベントを特定します。	-	null
filter.domain	特定のドメインからのイベントを特定します。`String`	-	null
filter.resourceType	特定のリソース型に関連するイベントを特定します。`String`	-	null
filter.type	それらの型に基づいてイベントを特定します。`String`	-	null
filter.level	レベルに基づいてイベントを特定します。`String`	-	null

1.1.1.5. レスポンス
リンクのコピー

Expand

表1.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountAdministrationEventsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.1.6. Samples
リンクのコピー

1.1.2. GetAdministrationEvent
リンクのコピー

GET /v1/administration/events/{id}

GetAdministrationEvent は ID によってイベントを取得します。

1.1.2.1. 説明
リンクのコピー

1.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

1.1.2.5. レスポンス
リンクのコピー

Expand

表1.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAdministrationEventResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.2.6. Samples
リンクのコピー

1.1.3. ListAdministrationEvents
リンクのコピー

GET /v1/administration/events

ListAdministrationEvents は、要求されたフィールドに基づいてフィルタリングした後のイベントのリストを返します。

1.1.3.1. 説明
リンクのコピー

1.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.from	特定のタイムスタンプ (下限) より後の last_occurred_at が含まれるイベントを特定します。	-	null
filter.until	特定のタイムスタンプ (上限) より前の last_occurred_at が含まれるイベントを特定します。	-	null
filter.domain	特定のドメインからのイベントを特定します。`String`	-	null
filter.resourceType	特定のリソース型に関連するイベントを特定します。`String`	-	null
filter.type	それらの型に基づいてイベントを特定します。`String`	-	null
filter.level	レベルに基づいてイベントを特定します。`String`	-	null

1.1.3.5. レスポンス
リンクのコピー

Expand

表1.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAdministrationEventsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.3.6. Samples
リンクのコピー

第2章 Administration Usage Service
リンクのコピー

2.1. Administration Usage Service
リンクのコピー

2.1.1. GetCurrentSecuredUnitsUsage
リンクのコピー

GET /v1/administration/usage/secured-units/current

GetCurrentSecuredUnitsUsage は、現在セキュアなユニットの使用状況のメトリクス値を返します。

2.1.1.1. 説明
リンクのコピー

セキュアなユニットのメトリクスは、5 分間隔ですべての接続クラスターから収集されるため、返される結果には、その 5 分間においては正確な接続クラスターのデータが含まれます。ただし、古くなった非接続クラスターのデータも含まれる可能性があります。

2.1.1.5. レスポンス
リンクのコピー

Expand

表2.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1SecuredUnitsUsageResponse
0	予期しないエラーの応答。	GooglerpcStatus

2.1.1.6. Samples
リンクのコピー

2.1.2. GetMaxSecuredUnitsUsage
リンクのコピー

GET /v1/administration/usage/secured-units/max

GetMaxSecuredUnitsUsage は、指定された時間範囲内で確認されたセキュアなユニットの最大値 (つまりピーク) と、この最大値が集計、保存された時刻を返します。

2.1.2.1. 説明
リンクのコピー

使用状況メトリクスは、すべての接続クラスターから継続的に収集されます。最大値は一定期間メモリー内に保持され、その後定期的にデータベースに保存されます。非接続クラスターからの最後のデータが考慮されます。

2.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
from		-	null
to		-	null

2.1.2.5. レスポンス
リンクのコピー

Expand

表2.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1MaxSecuredUnitsUsageResponse
0	予期しないエラーの応答。	GooglerpcStatus

2.1.2.6. Samples
リンクのコピー

第3章 Alert Service
リンクのコピー

3.1. Alert Service
リンクのコピー

3.1.1. CountAlerts
リンクのコピー

GET /v1/alertscount

CountAlerts は、get リクエストに一致するアラートの数をカウントします。

3.1.1.1. 説明
リンクのコピー

3.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.1.5. レスポンス
リンクのコピー

Expand

表3.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.1.6. Samples
リンクのコピー

3.1.2. DeleteAlerts
リンクのコピー

DELETE /v1/alerts

3.1.2.1. 説明
リンクのコピー

3.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null
confirm	-	null

3.1.2.5. レスポンス
リンクのコピー

Expand

表3.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeleteAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.2.6. Samples
リンクのコピー

3.1.3. GetAlert
リンクのコピー

GET /v1/alerts/{id}

GetAlert は、id が指定されたアラートを返します。

3.1.3.1. 説明
リンクのコピー

3.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

3.1.3.5. レスポンス
リンクのコピー

Expand

表3.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAlert
0	予期しないエラーの応答。	GooglerpcStatus

3.1.3.6. Samples
リンクのコピー

3.1.4. GetAlertTimeseries
リンクのコピー

GET /v1/alerts/summary/timeseries

GetAlertTimeseries は、アラートを時間順にソートして返します。

3.1.4.1. 説明
リンクのコピー

3.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.4.5. レスポンス
リンクのコピー

Expand

表3.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertTimeseriesResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.4.6. Samples
リンクのコピー

3.1.5. GetAlertsCounts
リンクのコピー

GET /v1/alerts/summary/counts

GetAlertsCounts は、要求されたクラスターまたはカテゴリー内のアラートの数を返します。

3.1.5.1. 説明
リンクのコピー

3.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
request.query	-	null
request.pagination.limit	-	null
request.pagination.offset	-	null
request.pagination.sortOption.field	-	null
request.pagination.sortOption.reversed	-	null
request.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
request.pagination.sortOption.aggregateBy.distinct	-	null
groupBy	-	UNSET

3.1.5.5. レスポンス
リンクのコピー

Expand

表3.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertsCountsResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.5.6. Samples
リンクのコピー

3.1.6. GetAlertsGroup
リンクのコピー

GET /v1/alerts/summary/groups

GetAlertsGroup は、ポリシーごとにグループ化されたアラートを返します。

3.1.6.1. 説明
リンクのコピー

3.1.6.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.6.5. レスポンス
リンクのコピー

Expand

表3.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertsGroupResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.6.6. Samples
リンクのコピー

3.1.7. ListAlerts
リンクのコピー

GET /v1/alerts

List は、アラートのスリムリストバージョンを返します。

3.1.7.1. 説明
リンクのコピー

3.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.7.5. レスポンス
リンクのコピー

Expand

表3.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

3.1.7.6. Samples
リンクのコピー

3.1.8. ResolveAlert
リンクのコピー

PATCH /v1/alerts/{id}/resolve

ResolveAlert は、指定されたアラート (ID 別) を解決済みとしてマークします。

3.1.8.1. 説明
リンクのコピー

3.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

3.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	AlertServiceResolveAlertBody	X

3.1.8.5. レスポンス
リンクのコピー

Expand

表3.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

3.1.8.6. Samples
リンクのコピー

3.1.9. ResolveAlerts
リンクのコピー

PATCH /v1/alerts/resolve

ResolveAlertsByQuery は、検索クエリーに一致するアラートを解決済みとしてマークします。

3.1.9.1. 説明
リンクのコピー

3.1.9.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ResolveAlertsRequest	X

3.1.9.5. レスポンス
リンクのコピー

Expand

表3.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

3.1.9.6. Samples
リンクのコピー

第4章 APIToken Service
リンクのコピー

4.1. A P I Token Service
リンクのコピー

4.1.1. GenerateToken
リンクのコピー

POST /v1/apitokens/generate

GenerateToken は、指定されたユーザーとロールの API トークンを生成します。

4.1.1.1. 説明
リンクのコピー

4.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1GenerateTokenRequest	X

4.1.1.5. レスポンス
リンクのコピー

Expand

表4.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GenerateTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

4.1.1.6. Samples
リンクのコピー

4.1.2. GetAPIToken
リンクのコピー

GET /v1/apitokens/{id}

GetAPIToken は、指定された id の API トークンメタデータを返します。

4.1.2.1. 説明
リンクのコピー

4.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

4.1.2.5. レスポンス
リンクのコピー

Expand

表4.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageTokenMetadata
0	予期しないエラーの応答。	GooglerpcStatus

4.1.2.6. Samples
リンクのコピー

4.1.3. GetAPITokens
リンクのコピー

GET /v1/apitokens

GetAPITokens はすべての API トークンを返します。

4.1.3.1. 説明
リンクのコピー

4.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
revoked		-	null

4.1.3.5. レスポンス
リンクのコピー

Expand

表4.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAPITokensResponse
0	予期しないエラーの応答。	GooglerpcStatus

4.1.3.6. Samples
リンクのコピー

4.1.4. ListAllowedTokenRoles
リンクのコピー

GET /v1/apitokens/generate/allowed-roles

GetAllowedTokenRoles は、ユーザーが API トークンをリクエストできるロールを返します。

4.1.4.1. 説明
リンクのコピー

4.1.4.5. レスポンス
リンクのコピー

Expand

表4.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAllowedTokenRolesResponse
0	予期しないエラーの応答。	GooglerpcStatus

4.1.4.6. Samples
リンクのコピー

4.1.5. RevokeToken
リンクのコピー

PATCH /v1/apitokens/revoke/{id}

RevokeToken は、指定された id の API トークンを削除します。

4.1.5.1. 説明
リンクのコピー

4.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

4.1.5.5. レスポンス
リンクのコピー

Expand

表4.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

4.1.5.6. Samples
リンクのコピー

第5章 Auth Provider Service
リンクのコピー

5.1. Auth Provider Service
リンクのコピー

5.1.1. DeleteAuthProvider
リンクのコピー

DELETE /v1/authProviders/{id}

5.1.1.1. 説明
リンクのコピー

5.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

5.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
force		-	null

5.1.1.5. レスポンス
リンクのコピー

Expand

表5.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

5.1.1.6. Samples
リンクのコピー

5.1.2. ExchangeToken
リンクのコピー

POST /v1/authProviders/exchangeToken

5.1.2.1. 説明
リンクのコピー

5.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ExchangeTokenRequest	X

5.1.2.5. レスポンス
リンクのコピー

Expand

表5.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ExchangeTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

5.1.2.6. Samples
リンクのコピー

5.1.3. GetAuthProvider
リンクのコピー

GET /v1/authProviders/{id}

5.1.3.1. 説明
リンクのコピー

5.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

5.1.3.5. レスポンス
リンクのコピー

Expand

表5.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

5.1.3.6. Samples
リンクのコピー

5.1.4. GetAuthProviders
リンクのコピー

GET /v1/authProviders

5.1.4.1. 説明
リンクのコピー

5.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
name		-	null
type		-	null

5.1.4.5. レスポンス
リンクのコピー

Expand

表5.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAuthProvidersResponse
0	予期しないエラーの応答。	GooglerpcStatus

5.1.4.6. Samples
リンクのコピー

5.1.5. GetLoginAuthProviders
リンクのコピー

GET /v1/login/authproviders

5.1.5.1. 説明
リンクのコピー

5.1.5.5. レスポンス
リンクのコピー

Expand

表5.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetLoginAuthProvidersResponse
0	予期しないエラーの応答。	GooglerpcStatus

5.1.5.6. Samples
リンクのコピー

5.1.6. ListAvailableProviderTypes
リンクのコピー

GET /v1/availableAuthProviders

5.1.6.1. 説明
リンクのコピー

5.1.6.5. レスポンス
リンクのコピー

Expand

表5.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AvailableProviderTypesResponse
0	予期しないエラーの応答。	GooglerpcStatus

5.1.6.6. Samples
リンクのコピー

5.1.7. PostAuthProvider
リンクのコピー

POST /v1/authProviders

5.1.7.1. 説明
リンクのコピー

5.1.7.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
provider	StorageAuthProvider	X

5.1.7.5. レスポンス
リンクのコピー

Expand

表5.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

5.1.7.6. Samples
リンクのコピー

5.1.8. PutAuthProvider
リンクのコピー

PUT /v1/authProviders/{id}

5.1.8.1. 説明
リンクのコピー

5.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

5.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	AuthProviderServicePutAuthProviderBody	X

5.1.8.5. レスポンス
リンクのコピー

Expand

表5.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

5.1.8.6. Samples
リンクのコピー

5.1.9. UpdateAuthProvider
リンクのコピー

PATCH /v1/authProviders/{id}

5.1.9.1. 説明
リンクのコピー

5.1.9.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

5.1.9.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	AuthProviderServiceUpdateAuthProviderBody	X

5.1.9.5. レスポンス
リンクのコピー

Expand

表5.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

5.1.9.6. Samples
リンクのコピー

第6章 Auth Service
リンクのコピー

6.1. Auth Service
リンクのコピー

6.1.1. AddAuthMachineToMachineConfig
リンクのコピー

POST /v1/auth/m2m

AddAuthMachineToMachineConfig は、machine to machine 認証を新規作成します。

6.1.1.1. 説明
リンクのコピー

6.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1AddAuthMachineToMachineConfigRequest	X

6.1.1.5. レスポンス
リンクのコピー

Expand

表6.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AddAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

6.1.1.6. Samples
リンクのコピー

6.1.2. DeleteAuthMachineToMachineConfig
リンクのコピー

DELETE /v1/auth/m2m/{id}

DeleteAuthMachineToMachineConfig は、特定の machine to machine 認証設定を削除します。指定された machine to machine 認証設定が存在しない場合に削除すると、エラーは返されません。

6.1.2.1. 説明
リンクのコピー

6.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

6.1.2.5. レスポンス
リンクのコピー

Expand

表6.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

6.1.2.6. Samples
リンクのコピー

6.1.3. ExchangeAuthMachineToMachineToken
リンクのコピー

POST /v1/auth/m2m/exchange

ExchangeAuthMachineToMachineToken は、machine to machine 認証設定に基づいて、指定されたアイデンティティートークンを Central のアクセストークンと交換します。

6.1.3.1. 説明
リンクのコピー

6.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ExchangeAuthMachineToMachineTokenRequest	X

6.1.3.3. 戻り値のタイプ
リンクのコピー

V1ExchangeAuthMachineToMachineTokenResponse

6.1.3.5. レスポンス
リンクのコピー

Expand

表6.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ExchangeAuthMachineToMachineTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

6.1.3.6. Samples
リンクのコピー

6.1.4. GetAuthMachineToMachineConfig
リンクのコピー

GET /v1/auth/m2m/{id}

GetAuthMachineToMachineConfig は、特定の machine to machine 認証設定を取得します。

6.1.4.1. 説明
リンクのコピー

6.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

6.1.4.5. レスポンス
リンクのコピー

Expand

表6.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

6.1.4.6. Samples
リンクのコピー

6.1.5. GetAuthStatus
リンクのコピー

GET /v1/auth/status

GetAuthStatus は、現在のクライアントのステータスを返します。

6.1.5.1. 説明
リンクのコピー

6.1.5.5. レスポンス
リンクのコピー

Expand

表6.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AuthStatus
0	予期しないエラーの応答。	GooglerpcStatus

6.1.5.6. Samples
リンクのコピー

6.1.6. ListAuthMachineToMachineConfigs
リンクのコピー

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs は、使用可能な machine to machine の認証設定を表示します。

6.1.6.1. 説明
リンクのコピー

6.1.6.3. 戻り値のタイプ
リンクのコピー

V1ListAuthMachineToMachineConfigResponse

6.1.6.5. レスポンス
リンクのコピー

Expand

表6.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

6.1.6.6. Samples
リンクのコピー

6.1.7. UpdateAuthMachineToMachineConfig
リンクのコピー

PUT /v1/auth/m2m/{config.id}

UpdateAuthMachineToMachineConfig は、既存の machine-to-machine (M2M) 認証設定を更新します。machine-to-machine (M2M) 認証設定が存在しない場合は、新しい設定が作成されます。

6.1.7.1. 説明
リンクのコピー

6.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
config.id	設定の UUID。machine to machine 設定に追加する際に、このフィールドは設定できないことに注意してください。	X	null

6.1.7.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	AuthServiceUpdateAuthMachineToMachineConfigBody	X

6.1.7.5. レスポンス
リンクのコピー

Expand

表6.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

6.1.7.6. Samples
リンクのコピー

第7章 Central Health Service
リンクのコピー

7.1. Central Health Service
リンクのコピー

7.1.1. GetUpgradeStatus
リンクのコピー

GET /v1/centralhealth/upgradestatus

7.1.1.1. 説明
リンクのコピー

7.1.1.5. レスポンス
リンクのコピー

Expand

表7.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetUpgradeStatusResponse
0	予期しないエラーの応答。	GooglerpcStatus

7.1.1.6. Samples
リンクのコピー

第8章 Cloud Sources Service
リンクのコピー

8.1. Cloud Sources Service
リンクのコピー

8.1.1. CountCloudSources
リンクのコピー

GET /v1/count/cloud-sources

CountCloudSources は、要求されたフィールドでフィルタリングした後、クラウドソースの数を返します。

8.1.1.1. 説明
リンクのコピー

8.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
filter.names	名前に基づいてクラウドソースを照合します。`String`	-	null
filter.types	クラウドソースをタイプに基づいて照合します。`String`	-	null

8.1.1.5. レスポンス
リンクのコピー

Expand

表8.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountCloudSourcesResponse
0	予期しないエラーの応答。	GooglerpcStatus

8.1.1.6. Samples
リンクのコピー

8.1.2. CreateCloudSource
リンクのコピー

POST /v1/cloud-sources

CreateCloudSource はクラウドソースを作成します。

8.1.2.1. 説明
リンクのコピー

8.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1CreateCloudSourceRequest	X

8.1.2.5. レスポンス
リンクのコピー

Expand

表8.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CreateCloudSourceResponse
0	予期しないエラーの応答。	GooglerpcStatus

8.1.2.6. Samples
リンクのコピー

8.1.3. DeleteCloudSource
リンクのコピー

DELETE /v1/cloud-sources/{id}

DeleteCloudSource はクラウドソースを削除します。

8.1.3.1. 説明
リンクのコピー

8.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

8.1.3.5. レスポンス
リンクのコピー

Expand

表8.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

8.1.3.6. Samples
リンクのコピー

8.1.4. GetCloudSource
リンクのコピー

GET /v1/cloud-sources/{id}

GetCloudSource は ID によってクラウドソースを取得します。

8.1.4.1. 説明
リンクのコピー

8.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

8.1.4.5. レスポンス
リンクのコピー

Expand

表8.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCloudSourceResponse
0	予期しないエラーの応答。	GooglerpcStatus

8.1.4.6. Samples
リンクのコピー

8.1.5. ListCloudSources
リンクのコピー

GET /v1/cloud-sources

ListCloudSources は、要求されたフィールドに基づいてフィルタリングしたクラウドソースのリストを返します。

8.1.5.1. 説明
リンクのコピー

8.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.names	名前に基づいてクラウドソースを照合します。`String`	-	null
filter.types	クラウドソースをタイプに基づいて照合します。`String`	-	null

8.1.5.5. レスポンス
リンクのコピー

Expand

表8.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCloudSourcesResponse
0	予期しないエラーの応答。	GooglerpcStatus

8.1.5.6. Samples
リンクのコピー

8.1.6. TestCloudSource
リンクのコピー

POST /v1/cloud-sources/test

TestCloudSource はクラウドソースをテストします。

8.1.6.1. 説明
リンクのコピー

8.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1TestCloudSourceRequest	X

8.1.6.5. レスポンス
リンクのコピー

Expand

表8.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

8.1.6.6. Samples
リンクのコピー

8.1.7. UpdateCloudSource
リンクのコピー

PUT /v1/cloud-sources/{cloudSource.id}

UpdateCloudSource はクラウドソースを作成または置き換えます。

8.1.7.1. 説明
リンクのコピー

8.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
cloudSource.id		X	null

8.1.7.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	CloudSourcesServiceUpdateCloudSourceBody	X

8.1.7.5. レスポンス
リンクのコピー

Expand

表8.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

8.1.7.6. Samples
リンクのコピー

第9章 Cluster CVEService
リンクのコピー

9.1. Cluster C V E Service
リンクのコピー

9.1.1. SuppressCVEs
リンクのコピー

PATCH /v1/clustercves/suppress

SuppressCVE はクラスター CVE を抑制します。

9.1.1.1. 説明
リンクのコピー

9.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1SuppressCVERequest	X

9.1.1.5. レスポンス
リンクのコピー

Expand

表9.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

9.1.1.6. Samples
リンクのコピー

9.1.2. UnsuppressCVEs
リンクのコピー

PATCH /v1/clustercves/unsuppress

UnsuppressCVE はクラスター CVE を抑制解除します。

9.1.2.1. 説明
リンクのコピー

9.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UnsuppressCVERequest	X

9.1.2.5. レスポンス
リンクのコピー

Expand

表9.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

9.1.2.6. Samples
リンクのコピー

第10章 Cluster Init Service
リンクのコピー

10.1. Cluster Init Service
リンクのコピー

10.1.1. GenerateCRS
リンクのコピー

POST /v1/cluster-init/crs

10.1.1.1. 説明
リンクのコピー

10.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1CRSGenRequest	X

10.1.1.5. レスポンス
リンクのコピー

Expand

表10.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSGenResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.1.6. Samples
リンクのコピー

10.1.2. GenerateInitBundle
リンクのコピー

POST /v1/cluster-init/init-bundles

10.1.2.1. 説明
リンクのコピー

10.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1InitBundleGenRequest	X

10.1.2.5. レスポンス
リンクのコピー

Expand

表10.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleGenResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.2.6. Samples
リンクのコピー

10.1.3. GetCAConfig
リンクのコピー

GET /v1/cluster-init/ca-config

10.1.3.1. 説明
リンクのコピー

10.1.3.5. レスポンス
リンクのコピー

Expand

表10.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCAConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.3.6. Samples
リンクのコピー

10.1.4. GetCRSs
リンクのコピー

GET /v1/cluster-init/crs

10.1.4.1. 説明
リンクのコピー

10.1.4.5. レスポンス
リンクのコピー

Expand

表10.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSMetasResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.4.6. Samples
リンクのコピー

10.1.5. GetInitBundles
リンクのコピー

GET /v1/cluster-init/init-bundles

10.1.5.1. 説明
リンクのコピー

10.1.5.5. レスポンス
リンクのコピー

Expand

表10.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleMetasResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.5.6. Samples
リンクのコピー

10.1.6. RevokeCRS
リンクのコピー

PATCH /v1/cluster-init/crs/revoke

RevokeCRSBundle はクラスター登録シークレットを削除します。

10.1.6.1. 説明
リンクのコピー

10.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1CRSRevokeRequest	X

10.1.6.5. レスポンス
リンクのコピー

Expand

表10.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSRevokeResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.6.6. Samples
リンクのコピー

10.1.7. RevokeInitBundle
リンクのコピー

PATCH /v1/cluster-init/init-bundles/revoke

RevokeInitBundle はクラスターの初期化バンドルを削除します。この操作がいずれかのクラスターに影響する場合は、その ID をリクエストに含める必要があります。confirm_impacted_clusters_ids が現在影響を受けているクラスターと一致しない場合、影響を受けるすべてのクラスターを含むエラーでリクエストは失敗します。

10.1.7.1. 説明
リンクのコピー

10.1.7.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1InitBundleRevokeRequest	X

10.1.7.5. レスポンス
リンクのコピー

Expand

表10.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleRevokeResponse
0	予期しないエラーの応答。	GooglerpcStatus

10.1.7.6. Samples
リンクのコピー

第11章 Clusters Service
リンクのコピー

11.1. Clusters Service
リンクのコピー

11.1.1. DeleteCluster
リンクのコピー

DELETE /v1/clusters/{id}

11.1.1.1. 説明
リンクのコピー

11.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

11.1.1.5. レスポンス
リンクのコピー

Expand

表11.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

11.1.1.6. Samples
リンクのコピー

11.1.2. GetCluster
リンクのコピー

GET /v1/clusters/{id}

11.1.2.1. 説明
リンクのコピー

11.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

11.1.2.5. レスポンス
リンクのコピー

Expand

表11.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

11.1.2.6. Samples
リンクのコピー

11.1.3. GetClusterDefaultValues
リンクのコピー

GET /v1/cluster-defaults

11.1.3.1. 説明
リンクのコピー

11.1.3.5. レスポンス
リンクのコピー

Expand

表11.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterDefaultsResponse
0	予期しないエラーの応答。	GooglerpcStatus

11.1.3.6. Samples
リンクのコピー

11.1.4. GetClusters
リンクのコピー

GET /v1/clusters

11.1.4.1. 説明
リンクのコピー

11.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
query		-	null

11.1.4.5. レスポンス
リンクのコピー

Expand

表11.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClustersList
0	予期しないエラーの応答。	GooglerpcStatus

11.1.4.6. Samples
リンクのコピー

11.1.5. GetKernelSupportAvailable
リンクのコピー

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable は非推奨になり、代わりに GetClusterDefaultValues が推奨されます。

11.1.5.1. 説明
リンクのコピー

11.1.5.5. レスポンス
リンクのコピー

Expand

表11.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1KernelSupportAvailableResponse
0	予期しないエラーの応答。	GooglerpcStatus

11.1.5.6. Samples
リンクのコピー

11.1.6. PostCluster
リンクのコピー

POST /v1/clusters

11.1.6.1. 説明
リンクのコピー

11.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageCluster	X

11.1.6.5. レスポンス
リンクのコピー

Expand

表11.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

11.1.6.6. Samples
リンクのコピー

11.1.7. PutCluster
リンクのコピー

PUT /v1/clusters/{id}

11.1.7.1. 説明
リンクのコピー

11.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

11.1.7.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ClustersServicePutClusterBody	X

11.1.7.5. レスポンス
リンクのコピー

Expand

表11.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

11.1.7.6. Samples
リンクのコピー

第12章 Collection Service
リンクのコピー

12.1. Collection Service
リンクのコピー

12.1.1. CreateCollection
リンクのコピー

POST /v1/collections

12.1.1.1. 説明
リンクのコピー

12.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1CreateCollectionRequest	X

12.1.1.5. レスポンス
リンクのコピー

Expand

表12.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CreateCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.1.6. Samples
リンクのコピー

12.1.2. DeleteCollection
リンクのコピー

DELETE /v1/collections/{id}

12.1.2.1. 説明
リンクのコピー

12.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

12.1.2.5. レスポンス
リンクのコピー

Expand

表12.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

12.1.2.6. Samples
リンクのコピー

12.1.3. DryRunCollection
リンクのコピー

POST /v1/collections/dryrun

12.1.3.1. 説明
リンクのコピー

12.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1DryRunCollectionRequest	X

12.1.3.5. レスポンス
リンクのコピー

Expand

表12.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DryRunCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.3.6. Samples
リンクのコピー

12.1.4. GetCollection
リンクのコピー

GET /v1/collections/{id}

12.1.4.1. 説明
リンクのコピー

12.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

12.1.4.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
options.withMatches	-	null
options.filterQuery.query	-	null
options.filterQuery.pagination.limit	-	null
options.filterQuery.pagination.offset	-	null
options.filterQuery.pagination.sortOption.field	-	null
options.filterQuery.pagination.sortOption.reversed	-	null
options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
options.filterQuery.pagination.sortOption.aggregateBy.distinct	-	null

12.1.4.5. レスポンス
リンクのコピー

Expand

表12.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.4.6. Samples
リンクのコピー

12.1.5. GetCollectionCount
リンクのコピー

GET /v1/collectionscount

12.1.5.1. 説明
リンクのコピー

12.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

12.1.5.5. レスポンス
リンクのコピー

Expand

表12.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCollectionCountResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.5.6. Samples
リンクのコピー

12.1.6. ListCollectionSelectors
リンクのコピー

GET /v1/collections/selectors

12.1.6.1. 説明
リンクのコピー

12.1.6.5. レスポンス
リンクのコピー

Expand

表12.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCollectionSelectorsResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.6.6. Samples
リンクのコピー

12.1.7. ListCollections
リンクのコピー

GET /v1/collections

12.1.7.1. 説明
リンクのコピー

12.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

12.1.7.5. レスポンス
リンクのコピー

Expand

表12.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCollectionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.7.6. Samples
リンクのコピー

12.1.8. UpdateCollection
リンクのコピー

PATCH /v1/collections/{id}

12.1.8.1. 説明
リンクのコピー

12.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

12.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	CollectionServiceUpdateCollectionBody	X

12.1.8.5. レスポンス
リンクのコピー

Expand

表12.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1UpdateCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

12.1.8.6. Samples
リンクのコピー

第13章 Compliance Integration Service
リンクのコピー

13.1. Compliance Integration Service
リンクのコピー

13.1.1. ListComplianceIntegrations
リンクのコピー

GET /v2/compliance/integrations

ListComplianceIntegrations は、セキュアクラスターのすべての Compliance Operator メタデータをリスト表示します。

13.1.1.1. 説明
リンクのコピー

13.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

13.1.1.5. レスポンス
リンクのコピー

Expand

表13.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceIntegrationsResponse
0	予期しないエラーの応答。	RpcStatus

13.1.1.6. Samples
リンクのコピー

第14章 Compliance Management Service
リンクのコピー

14.1. Compliance Management Service
リンクのコピー

14.1.1. GetRecentRuns
リンクのコピー

GET /v1/complianceManagement/runs

14.1.1.1. 説明
リンクのコピー

14.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
clusterId	-	null
standardId	-	null
since	-	null

14.1.1.5. レスポンス
リンクのコピー

Expand

表14.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetRecentComplianceRunsResponse
0	予期しないエラーの応答。	GooglerpcStatus

14.1.1.6. Samples
リンクのコピー

14.1.2. GetRunStatuses
リンクのコピー

GET /v1/compliancemanagement/runstatuses

14.1.2.1. 説明
リンクのコピー

14.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
runIds	`String`	-	null
latest		-	null

14.1.2.5. レスポンス
リンクのコピー

Expand

表14.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceRunStatusesResponse
0	予期しないエラーの応答。	GooglerpcStatus

14.1.2.6. Samples
リンクのコピー

14.1.3. TriggerRuns
リンクのコピー

POST /v1/compliancemanagement/runs

14.1.3.1. 説明
リンクのコピー

14.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1TriggerComplianceRunsRequest	X

14.1.3.5. レスポンス
リンクのコピー

Expand

表14.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1TriggerComplianceRunsResponse
0	予期しないエラーの応答。	GooglerpcStatus

14.1.3.6. Samples
リンクのコピー

第15章 Compliance Profile Service
リンクのコピー

15.1. Compliance Profile Service
リンクのコピー

15.1.1. GetComplianceProfile
リンクのコピー

GET /v2/compliance/profile/{id}

GetComplianceProfile は指定されたコンプライアンスプロファイルを取得します

15.1.1.1. 説明
リンクのコピー

15.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

15.1.1.5. レスポンス
リンクのコピー

Expand

表15.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceProfile
0	予期しないエラーの応答。	RpcStatus

15.1.1.6. Samples
リンクのコピー

15.1.2. ListComplianceProfiles
リンクのコピー

GET /v2/compliance/profiles/cluster

ListComplianceProfiles は、指定されたリクエストに一致するプロファイルを返します

15.1.2.1. 説明
リンクのコピー

15.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
clusterId	-	null
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

15.1.2.5. レスポンス
リンクのコピー

Expand

表15.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfilesResponse
0	予期しないエラーの応答。	RpcStatus

15.1.2.6. Samples
リンクのコピー

15.1.3. ListProfileSummaries
リンクのコピー

GET /v2/compliance/profiles/summary

ListProfileSummaries は、各クラスターと指定されたクエリーに一致するプロファイルを返します

15.1.3.1. 説明
リンクのコピー

15.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
clusterIds	`String`	-	null
query.query		-	null
query.pagination.limit		-	null
query.pagination.offset		-	null
query.pagination.sortOption.field		-	null
query.pagination.sortOption.reversed		-	null
query.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
query.pagination.sortOption.aggregateBy.distinct		-	null

15.1.3.5. レスポンス
リンクのコピー

Expand

表15.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfileSummaryResponse
0	予期しないエラーの応答。	RpcStatus

15.1.3.6. Samples
リンクのコピー

第16章 Compliance Results Service
リンクのコピー

16.1. Compliance Results Service
リンクのコピー

16.1.1. GetComplianceProfileCheckDetails
リンクのコピー

GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}/details

GetComplianceProfileCheckDetails

16.1.1.1. 説明
リンクのコピー

16.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null
checkName		X	null

16.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

16.1.1.5. レスポンス
リンクのコピー

Expand

表16.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceClusterCheckStatus
0	予期しないエラーの応答。	RpcStatus

16.1.1.6. Samples
リンクのコピー

16.1.2. GetComplianceProfileCheckResult
リンクのコピー

GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}

GetComplianceProfileCheckResult はクラスターごとのチェックのステータスをリスト表示します

16.1.2.1. 説明
リンクのコピー

16.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null
checkName		X	null

16.1.2.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

16.1.2.5. レスポンス
リンクのコピー

Expand

表16.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceCheckClusterResponse
0	予期しないエラーの応答。	RpcStatus

16.1.2.6. Samples
リンクのコピー

16.1.3. GetComplianceProfileClusterResults
リンクのコピー

GET /v2/compliance/scan/results/profiles/{profileName}/clusters/{clusterId}

GetComplianceProfileClusterResults は、特定のクラスター上の特定のプロファイルのチェック結果をリスト表示します

16.1.3.1. 説明
リンクのコピー

16.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null
clusterId		X	null

16.1.3.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

16.1.3.5. レスポンス
リンクのコピー

Expand

表16.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceCheckResultResponse
0	予期しないエラーの応答。	RpcStatus

16.1.3.6. Samples
リンクのコピー

16.1.4. GetComplianceProfileResults
リンクのコピー

GET /v2/compliance/scan/results/profiles/{profileName}/checks

GetComplianceProfileResults は、指定されたクエリーの最新の Compliance Operator スキャン結果を取得します。オプションの RawQuery クエリーフィールドを組み合わせることができます。

16.1.4.1. 説明
リンクのコピー

16.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null

16.1.4.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

16.1.4.5. レスポンス
リンクのコピー

Expand

表16.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfileResults
0	予期しないエラーの応答。	RpcStatus

16.1.4.6. Samples
リンクのコピー

16.1.5. GetComplianceScanCheckResult
リンクのコピー

GET /v2/compliance/scan/result/{id}

GetComplianceScanCheckResult は ID で指定された結果を返します

16.1.5.1. 説明
リンクのコピー

16.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

16.1.5.5. レスポンス
リンクのコピー

Expand

表16.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceClusterCheckStatus
0	予期しないエラーの応答。	RpcStatus

16.1.5.6. Samples
リンクのコピー

16.1.6. GetComplianceScanConfigurationResults
リンクのコピー

GET /v2/compliance/scan/results/{scanConfigName}

GetComplianceScanConfigurationResults は、指定されたクエリーの最新の Compliance Operator スキャン結果を取得します。オプションの RawQuery クエリーフィールドを組み合わせることができます。

16.1.6.1. 説明
リンクのコピー

16.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
scanConfigName		X	null

16.1.6.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

16.1.6.5. レスポンス
リンクのコピー

Expand

表16.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceResultsResponse
0	予期しないエラーの応答。	RpcStatus

16.1.6.6. Samples
リンクのコピー

16.1.7. GetComplianceScanResults
リンクのコピー

GET /v2/compliance/scan/results

GetComplianceScanResults は、指定されたクエリーの最新の Compliance Operator スキャン結果を取得します。オプションの RawQuery クエリーフィールドを組み合わせることができます。以下がよく使用されますが、これらに限定されません。- scan: コンプライアンススキャンの ID - cluster: クラスターの ID - プロファイルの ID

16.1.7.1. 説明
リンクのコピー

16.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

16.1.7.5. レスポンス
リンクのコピー

Expand

表16.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceResultsResponse
0	予期しないエラーの応答。	RpcStatus

16.1.7.6. Samples
リンクのコピー

第17章 Compliance Results Stats Service
リンクのコピー

17.1. Compliance Results Stats Service
リンクのコピー

17.1.1. GetComplianceClusterScanStats
リンクのコピー

GET /v2/compliance/stats/configurations/clusters/{clusterId}

GetComplianceClusterScanStats は、スキャン設定ごとにクラスターの現在のスキャン統計情報をリスト表示します。

17.1.1.1. 説明
リンクのコピー

17.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

17.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

17.1.1.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceClusterScanStatsResponse

17.1.1.5. レスポンス
リンクのコピー

Expand

表17.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceClusterScanStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.1.6. Samples
リンクのコピー

17.1.2. GetComplianceClusterStats
リンクのコピー

GET /v2/compliance/scan/stats/profiles/{profileName}/clusters

17.1.2.1. 説明
リンクのコピー

17.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null

17.1.2.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

17.1.2.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceClusterOverallStatsResponse

17.1.2.5. レスポンス
リンクのコピー

Expand

表17.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceClusterOverallStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.2.6. Samples
リンクのコピー

17.1.3. GetComplianceOverallClusterStats
リンクのコピー

GET /v2/compliance/scan/stats/overall/cluster

非推奨となりました (GetComplianceClusterStats を優先)

17.1.3.1. 説明
リンクのコピー

17.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

17.1.3.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceClusterOverallStatsResponse

17.1.3.5. レスポンス
リンクのコピー

Expand

表17.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceClusterOverallStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.3.6. Samples
リンクのコピー

17.1.4. GetComplianceProfileCheckStats
リンクのコピー

GET /v2/compliance/scan/stats/profiles/{profileName}/checks/{checkName}

GetComplianceProfileCheckStats は、特定のクラスターチェックの現在の統計情報をリスト表示します。

17.1.4.1. 説明
リンクのコピー

17.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null
checkName		X	null

17.1.4.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

17.1.4.5. レスポンス
リンクのコピー

Expand

表17.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfileResults
0	予期しないエラーの応答。	RpcStatus

17.1.4.6. Samples
リンクのコピー

17.1.5. GetComplianceProfileStats
リンクのコピー

GET /v2/compliance/scan/stats/profiles/{profileName}

GetComplianceProfileStats は、プロファイルごとにグループ化された現在のスキャン統計情報をリスト表示します。オプションの RawQuery クエリーフィールドを組み合わせることができます。以下がよく使用されますが、これらに限定されません。- scan: コンプライアンススキャンの ID - cluster: クラスターの ID - プロファイルの ID

17.1.5.1. 説明
リンクのコピー

17.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
profileName		X	null

17.1.5.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

17.1.5.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceProfileScanStatsResponse

17.1.5.5. レスポンス
リンクのコピー

Expand

表17.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfileScanStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.5.6. Samples
リンクのコピー

17.1.6. GetComplianceProfilesClusterStats
リンクのコピー

GET /v2/compliance/scan/stats/profiles/clusters/{clusterId}

GetComplianceProfilesClusterStats は、プロファイルごとにグループ化されたクラスター統計情報をリストします。

17.1.6.1. 説明
リンクのコピー

17.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

17.1.6.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

17.1.6.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceClusterProfileStatsResponse

17.1.6.5. レスポンス
リンクのコピー

Expand

表17.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceClusterProfileStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.6.6. Samples
リンクのコピー

17.1.7. GetComplianceProfilesStats
リンクのコピー

GET /v2/compliance/scan/stats/profiles

GetComplianceProfileScanStats は、プロファイルごとにグループ化された現在のスキャン統計情報をリスト表示します。オプションの RawQuery クエリーフィールドを組み合わせることができます。以下がよく使用されますが、これらに限定されません。- scan: コンプライアンススキャンの ID - cluster: クラスターの ID - プロファイルの ID

17.1.7.1. 説明
リンクのコピー

17.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

17.1.7.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceProfileScanStatsResponse

17.1.7.5. レスポンス
リンクのコピー

Expand

表17.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceProfileScanStatsResponse
0	予期しないエラーの応答。	RpcStatus

17.1.7.6. Samples
リンクのコピー

第18章 Compliance Rule Service
リンクのコピー

18.1. Compliance Rule Service
リンクのコピー

18.1.1. GetComplianceRule
リンクのコピー

GET /v2/compliance/rule/summary/{ruleName}

GetComplianceRule は、指定されたリクエストに一致するルールを返します

18.1.1.1. 説明
リンクのコピー

18.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
ruleName		X	null

18.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

18.1.1.5. レスポンス
リンクのコピー

Expand

表18.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceRule
0	予期しないエラーの応答。	RpcStatus

18.1.1.6. Samples
リンクのコピー

第19章 Compliance Scan Configuration Service
リンクのコピー

19.1. Compliance Scan Configuration Service
リンクのコピー

19.1.1. CreateComplianceScanConfiguration
リンクのコピー

POST /v2/compliance/scan/configurations

CreateComplianceScanConfiguration はコンプライアンススキャン設定を作成します

19.1.1.1. 説明
リンクのコピー

19.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V2ComplianceScanConfiguration	X

19.1.1.5. レスポンス
リンクのコピー

Expand

表19.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceScanConfiguration
0	予期しないエラーの応答。	RpcStatus

19.1.1.6. Samples
リンクのコピー

19.1.2. DeleteComplianceScanConfiguration
リンクのコピー

DELETE /v2/compliance/scan/configurations/{id}

DeleteComplianceScanConfiguration は、指定された名前のコンプライアンススキャン設定を削除します。

19.1.2.1. 説明
リンクのコピー

19.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.2.5. レスポンス
リンクのコピー

Expand

表19.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

19.1.2.6. Samples
リンクのコピー

19.1.3. DeleteReport
リンクのコピー

DELETE /v2/compliance/scan/configurations/reports/{id}

DeleteReport は、指定されたスナップショット (スキャン実行) を削除します。

19.1.3.1. 説明
リンクのコピー

19.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.3.5. レスポンス
リンクのコピー

Expand

表19.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

19.1.3.6. Samples
リンクのコピー

19.1.4. GetComplianceScanConfiguration
リンクのコピー

GET /v2/compliance/scan/configurations/{id}

GetComplianceScanConfiguration は、指定されたコンプライアンススキャン設定を取得します

19.1.4.1. 説明
リンクのコピー

19.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.4.5. レスポンス
リンクのコピー

Expand

表19.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceScanConfigurationStatus
0	予期しないエラーの応答。	RpcStatus

19.1.4.6. Samples
リンクのコピー

19.1.5. GetMyReportHistory
リンクのコピー

GET /v2/compliance/scan/configurations/{id}/reports/my-history

GetMyReportHistory は、指定されたスキャン設定から現行ユーザーが実行したスナップショット (スキャン実行) のリストを返します。

19.1.5.1. 説明
リンクのコピー

19.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.5.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

19.1.5.5. レスポンス
リンクのコピー

Expand

表19.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceReportHistoryResponse
0	予期しないエラーの応答。	RpcStatus

19.1.5.6. Samples
リンクのコピー

19.1.6. GetReportHistory
リンクのコピー

GET /v2/compliance/scan/configurations/{id}/reports/history

GetReportHistory は、指定されたスキャン設定からのスナップショット (スキャン実行) のリストを返します。

19.1.6.1. 説明
リンクのコピー

19.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.6.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

19.1.6.5. レスポンス
リンクのコピー

Expand

表19.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceReportHistoryResponse
0	予期しないエラーの応答。	RpcStatus

19.1.6.6. Samples
リンクのコピー

19.1.7. ListComplianceScanConfigClusterProfiles
リンクのコピー

GET /v2/compliance/scan/configurations/clusters/{clusterId}/profiles/collection

GetComplianceScanConfiguration は、指定されたコンプライアンススキャン設定を取得します

19.1.7.1. 説明
リンクのコピー

19.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

19.1.7.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

19.1.7.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceScanConfigsClusterProfileResponse

19.1.7.5. レスポンス
リンクのコピー

Expand

表19.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceScanConfigsClusterProfileResponse
0	予期しないエラーの応答。	RpcStatus

19.1.7.6. Samples
リンクのコピー

19.1.8. ListComplianceScanConfigProfiles
リンクのコピー

GET /v2/compliance/scan/configurations/profiles/collection

ListComplianceScanConfigurations は、セキュアクラスターのすべての Compliance Operator スキャン設定をリストします。

19.1.8.1. 説明
リンクのコピー

19.1.8.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

19.1.8.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceScanConfigsProfileResponse

19.1.8.5. レスポンス
リンクのコピー

Expand

表19.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceScanConfigsProfileResponse
0	予期しないエラーの応答。	RpcStatus

19.1.8.6. Samples
リンクのコピー

19.1.9. ListComplianceScanConfigurations
リンクのコピー

GET /v2/compliance/scan/configurations

ListComplianceScanConfigurations は、セキュアクラスターのすべての Compliance Operator スキャン設定をリストします。

19.1.9.1. 説明
リンクのコピー

19.1.9.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

19.1.9.3. 戻り値のタイプ
リンクのコピー

V2ListComplianceScanConfigurationsResponse

19.1.9.5. レスポンス
リンクのコピー

Expand

表19.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListComplianceScanConfigurationsResponse
0	予期しないエラーの応答。	RpcStatus

19.1.9.6. Samples
リンクのコピー

19.1.10. RunComplianceScanConfiguration
リンクのコピー

POST /v2/compliance/scan/configurations/{id}/run

RunComplianceScanConfiguration は、指定されたスキャン設定のスキャンを起動します。これにより、設定済みのクラスター全体で適用可能なプロファイルに対して実行するスキャンを呼び出します。

19.1.10.1. 説明
リンクのコピー

19.1.10.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.10.5. レスポンス
リンクのコピー

Expand

表19.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

19.1.10.6. Samples
リンクのコピー

19.1.11. RunReport
リンクのコピー

POST /v2/compliance/scan/configurations/reports/run

RunReport は、スキャン設定のオンデマンドコンプライアンスレポートを実行します

19.1.11.1. 説明
リンクのコピー

19.1.11.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V2ComplianceRunReportRequest	X

19.1.11.5. レスポンス
リンクのコピー

Expand

表19.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ComplianceRunReportResponse
0	予期しないエラーの応答。	RpcStatus

19.1.11.6. Samples
リンクのコピー

19.1.12. UpdateComplianceScanConfiguration
リンクのコピー

PUT /v2/compliance/scan/configurations/{id}

UpdateComplianceScanConfiguration はコンプライアンススキャン設定を更新します

19.1.12.1. 説明
リンクのコピー

19.1.12.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

19.1.12.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ComplianceScanConfigurationServiceUpdateComplianceScanConfigurationBody	X

19.1.12.5. レスポンス
リンクのコピー

Expand

表19.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

19.1.12.6. Samples
リンクのコピー

第20章 Compliance Service
リンクのコピー

20.1. Compliance Service
リンクのコピー

20.1.1. GetAggregatedResults
リンクのコピー

GET /v1/compliance/aggregatedresults

20.1.1.1. 説明
リンクのコピー

20.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
groupBy	`String`	-	null
unit		-	UNKNOWN
where.query		-	null
where.pagination.limit		-	null
where.pagination.offset		-	null
where.pagination.sortOption.field		-	null
where.pagination.sortOption.reversed		-	null
where.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
where.pagination.sortOption.aggregateBy.distinct		-	null

20.1.1.5. レスポンス
リンクのコピー

Expand

表20.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageComplianceAggregationResponse
0	予期しないエラーの応答。	GooglerpcStatus

20.1.1.6. Samples
リンクのコピー

20.1.2. GetRunResults
リンクのコピー

GET /v1/compliance/runresults

20.1.2.1. 説明
リンクのコピー

20.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
clusterId		-	null
standardId		-	null
runId	結果を返す実行 ID を指定します。空の場合は、最新の実行が返されます。注意: このフィールドを設定すると、サーバー側の結果キャッシュが回避され、メモリー負荷が大幅に増加し、パフォーマンスが低下する可能性があります。	-	null

20.1.2.5. レスポンス
リンクのコピー

Expand

表20.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceRunResultsResponse
0	予期しないエラーの応答。	GooglerpcStatus

20.1.2.6. Samples
リンクのコピー

20.1.3. GetStandard
リンクのコピー

GET /v1/compliance/standards/{id}

20.1.3.1. 説明
リンクのコピー

20.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

20.1.3.5. レスポンス
リンクのコピー

Expand

表20.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceStandardResponse
0	予期しないエラーの応答。	GooglerpcStatus

20.1.3.6. Samples
リンクのコピー

20.1.4. GetStandards
リンクのコピー

GET /v1/compliance/standards

20.1.4.1. 説明
リンクのコピー

20.1.4.5. レスポンス
リンクのコピー

Expand

表20.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceStandardsResponse
0	予期しないエラーの応答。	GooglerpcStatus

20.1.4.6. Samples
リンクのコピー

20.1.5. UpdateComplianceStandardConfig
リンクのコピー

PATCH /v1/compliance/standards/{id}

20.1.5.1. 説明
リンクのコピー

20.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

20.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ComplianceServiceUpdateComplianceStandardConfigBody	X

20.1.5.5. レスポンス
リンクのコピー

Expand

表20.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

20.1.5.6. Samples
リンクのコピー

第21章 Config Service
リンクのコピー

21.1. Config Service
リンクのコピー

21.1.1. GetConfig
リンクのコピー

GET /v1/config

21.1.1.1. 説明
リンクのコピー

21.1.1.5. レスポンス
リンクのコピー

Expand

表21.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageConfig
0	予期しないエラーの応答。	GooglerpcStatus

21.1.1.6. Samples
リンクのコピー

21.1.2. GetPrivateConfig
リンクのコピー

GET /v1/config/private

21.1.2.1. 説明
リンクのコピー

21.1.2.5. レスポンス
リンクのコピー

Expand

表21.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePrivateConfig
0	予期しないエラーの応答。	GooglerpcStatus

21.1.2.6. Samples
リンクのコピー

21.1.3. GetPublicConfig
リンクのコピー

GET /v1/config/public

21.1.3.1. 説明
リンクのコピー

21.1.3.5. レスポンス
リンクのコピー

Expand

表21.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePublicConfig
0	予期しないエラーの応答。	GooglerpcStatus

21.1.3.6. Samples
リンクのコピー

21.1.4. GetVulnerabilityExceptionConfig
リンクのコピー

GET /v1/config/private/exception/vulnerabilities

21.1.4.1. 説明
リンクのコピー

21.1.4.3. 戻り値のタイプ
リンクのコピー

V1GetVulnerabilityExceptionConfigResponse

21.1.4.5. レスポンス
リンクのコピー

Expand

表21.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetVulnerabilityExceptionConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

21.1.4.6. Samples
リンクのコピー

21.1.5. PutConfig
リンクのコピー

PUT /v1/config

21.1.5.1. 説明
リンクのコピー

21.1.5.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1PutConfigRequest	X

21.1.5.5. レスポンス
リンクのコピー

Expand

表21.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageConfig
0	予期しないエラーの応答。	GooglerpcStatus

21.1.5.6. Samples
リンクのコピー

21.1.6. UpdateVulnerabilityExceptionConfig
リンクのコピー

PUT /v1/config/private/exception/vulnerabilities

21.1.6.1. 説明
リンクのコピー

21.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UpdateVulnerabilityExceptionConfigRequest	X

21.1.6.3. 戻り値のタイプ
リンクのコピー

V1UpdateVulnerabilityExceptionConfigResponse

21.1.6.5. レスポンス
リンクのコピー

Expand

表21.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1UpdateVulnerabilityExceptionConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

21.1.6.6. Samples
リンクのコピー

第22章 Credential Expiry Service
リンクのコピー

22.1. Credential Expiry Service
リンクのコピー

22.1.1. GetCertExpiry
リンクのコピー

GET /v1/credentialexpiry

GetCertExpiry は、有効期限コンポーネントの mTLS 証明書に関連する情報を返します。

22.1.1.1. 説明
リンクのコピー

22.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
component		-	UNKNOWN

22.1.1.5. レスポンス
リンクのコピー

Expand

表22.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCertExpiryResponse
0	予期しないエラーの応答。	GooglerpcStatus

22.1.1.6. Samples
リンクのコピー

第23章 DBService
リンクのコピー

23.1. D B Service
リンクのコピー

23.1.1. CancelRestoreProcess
リンクのコピー

DELETE /v1/db/restore/{id}

23.1.1.1. 説明
リンクのコピー

23.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

23.1.1.5. レスポンス
リンクのコピー

Expand

表23.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

23.1.1.6. Samples
リンクのコピー

23.1.2. GetActiveRestoreProcess
リンクのコピー

GET /v1/db/restore

23.1.2.1. 説明
リンクのコピー

23.1.2.5. レスポンス
リンクのコピー

Expand

表23.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetActiveDBRestoreProcessResponse
0	予期しないエラーの応答。	GooglerpcStatus

23.1.2.6. Samples
リンクのコピー

23.1.3. GetExportCapabilities
リンクのコピー

GET /v1/db/exportcaps

23.1.3.1. 説明
リンクのコピー

23.1.3.5. レスポンス
リンクのコピー

Expand

表23.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDBExportCapabilitiesResponse
0	予期しないエラーの応答。	GooglerpcStatus

23.1.3.6. Samples
リンクのコピー

23.1.4. InterruptRestoreProcess
リンクのコピー

POST /v1/db/interruptrestore/{processId}/{attemptId}

23.1.4.1. 説明
リンクのコピー

23.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
processId		X	null
attemptId		X	null

23.1.4.5. レスポンス
リンクのコピー

Expand

表23.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InterruptDBRestoreProcessResponse
0	予期しないエラーの応答。	GooglerpcStatus

23.1.4.6. Samples
リンクのコピー

第24章 Debug Service
リンクのコピー

24.1. Debug Service
リンクのコピー

24.1.1. GetLogLevel
リンクのコピー

GET /v1/debug/loglevel

StackRox サービスの現在のログレベルを取得します。

24.1.1.1. 説明
リンクのコピー

24.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
modules	`String`	-	null

24.1.1.5. レスポンス
リンクのコピー

Expand

表24.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1LogLevelResponse
0	予期しないエラーの応答。	GooglerpcStatus

24.1.1.6. Samples
リンクのコピー

24.1.2. ResetDBStats
リンクのコピー

POST /v1/debug/db/stats/reset

データベースのデバッグ統計をリセットします。

24.1.2.1. 説明
リンクのコピー

24.1.2.5. レスポンス
リンクのコピー

Expand

表24.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

24.1.2.6. Samples
リンクのコピー

24.1.3. SetLogLevel
リンクのコピー

PATCH /v1/debug/loglevel

StackRox サービスのログレベルを設定します。

24.1.3.1. 説明
リンクのコピー

24.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1LogLevelRequest	X

24.1.3.5. レスポンス
リンクのコピー

Expand

表24.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

24.1.3.6. Samples
リンクのコピー

24.1.4. StreamAuthzTraces
リンクのコピー

GET /v1/debug/authz/trace

すべての受信リクエストの認可トレース。

24.1.4.1. 説明
リンクのコピー

24.1.4.5. レスポンス
リンクのコピー

Expand

表24.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	成功した応答です。(ストリーミング応答)	v1AuthorizationTraceResponse のストリーム結果。
0	予期しないエラーの応答。	GooglerpcStatus

24.1.4.6. Samples
リンクのコピー

第25章 Declarative Config Health Service
リンクのコピー

25.1. Declarative Config Health Service
リンクのコピー

25.1.1. GetDeclarativeConfigHealths
リンクのコピー

GET /v1/declarative-config/health

25.1.1.1. 説明
リンクのコピー

25.1.1.5. レスポンス
リンクのコピー

Expand

表25.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDeclarativeConfigHealthsResponse
0	予期しないエラーの応答。	GooglerpcStatus

25.1.1.6. Samples
リンクのコピー

第26章 Delegated Registry Config Service
リンクのコピー

26.1. Delegated Registry Config Service
リンクのコピー

26.1.1. GetClusters
リンクのコピー

GET /v1/delegatedregistryconfig/clusters

GetClusters は、クラスターのリスト (id + 名前) と、委任されたレジストリー設定でクラスターを使用できるかどうかを示すフラグを返します。

26.1.1.1. 説明
リンクのコピー

26.1.1.5. レスポンス
リンクのコピー

Expand

表26.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DelegatedRegistryClustersResponse
0	予期しないエラーの応答。	GooglerpcStatus

26.1.1.6. Samples
リンクのコピー

26.1.2. GetConfig
リンクのコピー

GET /v1/delegatedregistryconfig

GetConfig は現在の委任レジストリー設定を返します

26.1.2.1. 説明
リンクのコピー

26.1.2.5. レスポンス
リンクのコピー

Expand

表26.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DelegatedRegistryConfig
0	予期しないエラーの応答。	GooglerpcStatus

26.1.2.6. Samples
リンクのコピー

26.1.3. UpdateConfig
リンクのコピー

PUT /v1/delegatedregistryconfig

UpdateConfig は保存された委任レジストリー設定を更新します

26.1.3.1. 説明
リンクのコピー

26.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	DelegatedRegistryConfig は、スキャン要求が委任されるかどうか、また委任先 (central サービスに保持されるか、特定のセキュアクラスターに送信されるかなど) を決定します。V1DelegatedRegistryConfig	X

26.1.3.5. レスポンス
リンクのコピー

Expand

表26.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DelegatedRegistryConfig
0	予期しないエラーの応答。	GooglerpcStatus

26.1.3.6. Samples
リンクのコピー

第27章 Deployment Service
リンクのコピー

27.1. Deployment Service
リンクのコピー

27.1.1. CountDeployments
リンクのコピー

GET /v1/deploymentscount

CountDeployments はデプロイメントの数を返します。

27.1.1.1. 説明
リンクのコピー

27.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

27.1.1.5. レスポンス
リンクのコピー

Expand

表27.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountDeploymentsResponse
0	予期しないエラーの応答。	GooglerpcStatus

27.1.1.6. Samples
リンクのコピー

27.1.2. ExportDeployments
リンクのコピー

GET /v1/export/deployments

27.1.2.1. 説明
リンクのコピー

27.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
timeout		-	null
query		-	null

27.1.2.5. レスポンス
リンクのコピー

Expand

表27.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	成功した応答です。(ストリーミング応答)	v1ExportDeploymentResponse のストリーム結果。
0	予期しないエラーの応答。	GooglerpcStatus

27.1.2.6. Samples
リンクのコピー

27.1.3. GetDeployment
リンクのコピー

GET /v1/deployments/{id}

GetDeployment は、ID が指定されたデプロイメントを返します。

27.1.3.1. 説明
リンクのコピー

27.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

27.1.3.5. レスポンス
リンクのコピー

Expand

表27.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageDeployment
0	予期しないエラーの応答。	GooglerpcStatus

27.1.3.6. Samples
リンクのコピー

27.1.4. GetDeploymentWithRisk
リンクのコピー

GET /v1/deploymentswithrisk/{id}

GetDeploymentWithRisk は、ID が指定されたデプロイメントとそのリスクを返します。

27.1.4.1. 説明
リンクのコピー

27.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

27.1.4.5. レスポンス
リンクのコピー

Expand

表27.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDeploymentWithRiskResponse
0	予期しないエラーの応答。	GooglerpcStatus

27.1.4.6. Samples
リンクのコピー

27.1.5. GetLabels
リンクのコピー

GET /v1/deployments/metadata/labels

GetLabels はデプロイメントで使用されるラベルを返します。

27.1.5.1. 説明
リンクのコピー

27.1.5.5. レスポンス
リンクのコピー

Expand

表27.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeploymentLabelsResponse
0	予期しないエラーの応答。	GooglerpcStatus

27.1.5.6. Samples
リンクのコピー

27.1.6. ListDeployments
リンクのコピー

GET /v1/deployments

ListDeployments はデプロイメントのリストを返します。

27.1.6.1. 説明
リンクのコピー

27.1.6.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

27.1.6.5. レスポンス
リンクのコピー

Expand

表27.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListDeploymentsResponse
0	予期しないエラーの応答。	GooglerpcStatus

27.1.6.6. Samples
リンクのコピー

27.1.7. ListDeploymentsWithProcessInfo
リンクのコピー

GET /v1/deploymentswithprocessinfo

ListDeploymentsWithProcessInfo は、プロセス情報を含むデプロイメントのリストを返します。

27.1.7.1. 説明
リンクのコピー

27.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

27.1.7.3. 戻り値のタイプ
リンクのコピー

V1ListDeploymentsWithProcessInfoResponse

27.1.7.5. レスポンス
リンクのコピー

Expand

表27.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListDeploymentsWithProcessInfoResponse
0	予期しないエラーの応答。	GooglerpcStatus

27.1.7.6. Samples
リンクのコピー

第28章 Detection Service
リンクのコピー

28.1. Detection Service
リンクのコピー

28.1.1. DetectBuildTime
リンクのコピー

POST /v1/detect/build

DetectBuildTime は、ビルド時のポリシーに違反するイメージがないか確認します。

28.1.1.1. 説明
リンクのコピー

28.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1BuildDetectionRequest	X

28.1.1.5. レスポンス
リンクのコピー

Expand

表28.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1BuildDetectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

28.1.1.6. Samples
リンクのコピー

28.1.2. DetectDeployTime
リンクのコピー

POST /v1/detect/deploy

DetectDeployTime は、デプロイメントがデプロイ時間ポリシーに違反しているかどうかを確認します。

28.1.2.1. 説明
リンクのコピー

28.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1DeployDetectionRequest	X

28.1.2.5. レスポンス
リンクのコピー

Expand

表28.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeployDetectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

28.1.2.6. Samples
リンクのコピー

28.1.3. DetectDeployTimeFromYAML
リンクのコピー

POST /v1/detect/deploy/yaml

DetectDeployTimeFromYAML は、指定されたデプロイメント yaml がデプロイ時間ポリシーに違反しているかどうかを確認します。

28.1.3.1. 説明
リンクのコピー

28.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1DeployYAMLDetectionRequest	X

28.1.3.5. レスポンス
リンクのコピー

Expand

表28.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeployDetectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

28.1.3.6. Samples
リンクのコピー

第29章 Discovered Clusters Service
リンクのコピー

29.1. Discovered Clusters Service
リンクのコピー

29.1.1. CountDiscoveredClusters
リンクのコピー

GET /v1/count/discovered-clusters

CountDiscoveredClusters は、要求されたフィールドでフィルタリングした後、検出されたクラスターの数を返します。

29.1.1.1. 説明
リンクのコピー

29.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
filter.names	検出されたクラスターの内、特定の名前を持つものと一致します。`String`	-	null
filter.types	検出されたクラスターの内、特定の型を持つものと一致します。`String`	-	null
filter.statuses	特定のステータスの検出クラスターを抽出します。- STATUS_UNSPECIFIED: クラスターのステータスは不明です。セキュアクラスターに一致する可能性のあるメタデータがない場合に発生する可能性があります。- STATUS_SECURED: 検出されたクラスターはセキュアクラスターと一致しました。- STATUS_UNSECURED: 検出されたクラスターはセキュアクラスターと一致しませんでした。`String`	-	null
filter.sourceIds	検出されたクラスターの内、特定のクラウドソース ID を持つものと一致します。`String`	-	null

29.1.1.5. レスポンス
リンクのコピー

Expand

表29.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountDiscoveredClustersResponse
0	予期しないエラーの応答。	GooglerpcStatus

29.1.1.6. Samples
リンクのコピー

29.1.2. GetDiscoveredCluster
リンクのコピー

GET /v1/discovered-clusters/{id}

GetDiscoveredCluster は、ID によって検出されたクラスターを取得します。

29.1.2.1. 説明
リンクのコピー

29.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

29.1.2.5. レスポンス
リンクのコピー

Expand

表29.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDiscoveredClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

29.1.2.6. Samples
リンクのコピー

29.1.3. ListDiscoveredClusters
リンクのコピー

GET /v1/discovered-clusters

ListDiscoveredClusters は、要求されたフィールドに基づいてフィルタリングした後に検出クラスターのリストを返します。

29.1.3.1. 説明
リンクのコピー

29.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.names	検出されたクラスターの内、特定の名前を持つものと一致します。`String`	-	null
filter.types	検出されたクラスターの内、特定の型を持つものと一致します。`String`	-	null
filter.statuses	特定のステータスの検出クラスターを抽出します。- STATUS_UNSPECIFIED: クラスターのステータスは不明です。セキュアクラスターに一致する可能性のあるメタデータがない場合に発生する可能性があります。- STATUS_SECURED: 検出されたクラスターはセキュアクラスターと一致しました。- STATUS_UNSECURED: 検出されたクラスターはセキュアクラスターと一致しませんでした。`String`	-	null
filter.sourceIds	検出されたクラスターの内、特定のクラウドソース ID を持つものと一致します。`String`	-	null

29.1.3.5. レスポンス
リンクのコピー

Expand

表29.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListDiscoveredClustersResponse
0	予期しないエラーの応答。	GooglerpcStatus

29.1.3.6. Samples
リンクのコピー

第30章 External Backup Service
リンクのコピー

30.1. External Backup Service
リンクのコピー

30.1.1. DeleteExternalBackup
リンクのコピー

DELETE /v1/externalbackups/{id}

DeleteExternalBackup は、ID が指定された外部バックアップ設定を削除します。

30.1.1.1. 説明
リンクのコピー

30.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

30.1.1.5. レスポンス
リンクのコピー

Expand

表30.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

30.1.1.6. Samples
リンクのコピー

30.1.2. GetExternalBackup
リンクのコピー

GET /v1/externalbackups/{id}

GetExternalBackup は、ID が指定されてた外部バックアップ設定を返します。

30.1.2.1. 説明
リンクのコピー

30.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

30.1.2.5. レスポンス
リンクのコピー

Expand

表30.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageExternalBackup
0	予期しないエラーの応答。	GooglerpcStatus

30.1.2.6. Samples
リンクのコピー

30.1.3. GetExternalBackups
リンクのコピー

GET /v1/externalbackups

GetExternalBackups は、すべての外部バックアップ設定を返します。

30.1.3.1. 説明
リンクのコピー

30.1.3.5. レスポンス
リンクのコピー

Expand

表30.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetExternalBackupsResponse
0	予期しないエラーの応答。	GooglerpcStatus

30.1.3.6. Samples
リンクのコピー

30.1.4. PostExternalBackup
リンクのコピー

POST /v1/externalbackups

PostExternalBackup は外部バックアップ設定を作成します。

30.1.4.1. 説明
リンクのコピー

30.1.4.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageExternalBackup	X

30.1.4.5. レスポンス
リンクのコピー

Expand

表30.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageExternalBackup
0	予期しないエラーの応答。	GooglerpcStatus

30.1.4.6. Samples
リンクのコピー

30.1.5. PutExternalBackup
リンクのコピー

PUT /v1/externalbackups/{id}

PutExternalBackup は、保存された認証情報の調整を使用せずに、指定された外部バックアップを変更します。

30.1.5.1. 説明
リンクのコピー

30.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

30.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ExternalBackupServicePutExternalBackupBody	X

30.1.5.5. レスポンス
リンクのコピー

Expand

表30.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageExternalBackup
0	予期しないエラーの応答。	GooglerpcStatus

30.1.5.6. Samples
リンクのコピー

30.1.6. TestExternalBackup
リンクのコピー

POST /v1/externalbackups/test

TestExternalBackup は外部バックアップ設定をテストします。

30.1.6.1. 説明
リンクのコピー

30.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageExternalBackup	X

30.1.6.5. レスポンス
リンクのコピー

Expand

表30.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

30.1.6.6. Samples
リンクのコピー

30.1.7. TestUpdatedExternalBackup
リンクのコピー

POST /v1/externalbackups/test/updated

TestUpdatedExternalBackup は、オプションで保存された認証情報の調整を使用して、指定された外部バックアップが正しく設定されているかどうかを確認します。

30.1.7.1. 説明
リンクのコピー

30.1.7.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UpdateExternalBackupRequest	X

30.1.7.5. レスポンス
リンクのコピー

Expand

表30.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

30.1.7.6. Samples
リンクのコピー

30.1.8. TriggerExternalBackup
リンクのコピー

POST /v1/externalbackups/{id}

TriggerExternalBackup は、指定された設定の外部バックアップを開始します。

30.1.8.1. 説明
リンクのコピー

30.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

30.1.8.5. レスポンス
リンクのコピー

Expand

表30.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

30.1.8.6. Samples
リンクのコピー

30.1.9. UpdateExternalBackup
リンクのコピー

PATCH /v1/externalbackups/{externalBackup.id}

UpdateExternalBackup は、オプションで保存された認証情報の調整を使用して、指定された外部バックアップを変更します。

30.1.9.1. 説明
リンクのコピー

30.1.9.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
externalBackup.id		X	null

30.1.9.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ExternalBackupServiceUpdateExternalBackupBody	X

30.1.9.5. レスポンス
リンクのコピー

Expand

表30.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageExternalBackup
0	予期しないエラーの応答。	GooglerpcStatus

30.1.9.6. Samples
リンクのコピー

第31章 Feature Flag Service
リンクのコピー

31.1. Feature Flag Service
リンクのコピー

31.1.1. GetFeatureFlags
リンクのコピー

GET /v1/featureflags

31.1.1.1. 説明
リンクのコピー

31.1.1.5. レスポンス
リンクのコピー

Expand

表31.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetFeatureFlagsResponse
0	予期しないエラーの応答。	GooglerpcStatus

31.1.1.6. Samples
リンクのコピー

第32章 Group Service
リンクのコピー

32.1. Group Service
リンクのコピー

32.1.1. BatchUpdate
リンクのコピー

POST /v1/groupsbatch

32.1.1.1. 説明
リンクのコピー

32.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1GroupBatchUpdateRequest	X

32.1.1.5. レスポンス
リンクのコピー

Expand

表32.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

32.1.1.6. Samples
リンクのコピー

32.1.2. CreateGroup
リンクのコピー

POST /v1/groups

32.1.2.1. 説明
リンクのコピー

32.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	グループは、GroupProperties : Role mapping です。StorageGroup	X

32.1.2.5. レスポンス
リンクのコピー

Expand

表32.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

32.1.2.6. Samples
リンクのコピー

32.1.3. DeleteGroup
リンクのコピー

DELETE /v1/groups

32.1.3.1. 説明
リンクのコピー

32.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
authProviderId	シームレスな HTTP API 移行のために、storage.GroupProperties からパラメーターをコピーします。	-	null
key		-	null
value		-	null
id		-	null
force		-	null

32.1.3.5. レスポンス
リンクのコピー

Expand

表32.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

32.1.3.6. Samples
リンクのコピー

32.1.4. GetGroup
リンクのコピー

GET /v1/group

32.1.4.1. 説明
リンクのコピー

32.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
id	グループプロパティーとそれぞれのグループの一意の識別子。	-	null
traits.mutabilityMode		-	ALLOW_MUTATE
traits.visibility		-	VISIBLE
traits.origin		-	IMPERATIVE
authProviderId		-	null
key		-	null
value		-	null

32.1.4.5. レスポンス
リンクのコピー

Expand

表32.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageGroup
0	予期しないエラーの応答。	GooglerpcStatus

32.1.4.6. Samples
リンクのコピー

32.1.5. GetGroups
リンクのコピー

GET /v1/groups

32.1.5.1. 説明
リンクのコピー

32.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
authProviderId	-	null
key	-	null
value	-	null
id	-	null

32.1.5.5. レスポンス
リンクのコピー

Expand

表32.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetGroupsResponse
0	予期しないエラーの応答。	GooglerpcStatus

32.1.5.6. Samples
リンクのコピー

32.1.6. UpdateGroup
リンクのコピー

PUT /v1/groups

32.1.6.1. 説明
リンクのコピー

32.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
group	StorageGroup	X

32.1.6.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
force		-	null

32.1.6.5. レスポンス
リンクのコピー

Expand

表32.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

32.1.6.6. Samples
リンクのコピー

第33章 GRPCPreferences Service
リンクのコピー

33.1. G R P C Preferences Service
リンクのコピー

33.1.1. Get
リンクのコピー

GET /v1/grpc-preferences

33.1.1.1. 説明
リンクのコピー

33.1.1.5. レスポンス
リンクのコピー

Expand

表33.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1Preferences
0	予期しないエラーの応答。	GooglerpcStatus

33.1.1.6. Samples
リンクのコピー

第34章 Image CVEService
リンクのコピー

34.1. Image C V E Service
リンクのコピー

34.1.1. SuppressCVEs
リンクのコピー

PATCH /v1/imagecves/suppress

SuppressCVE はイメージの CVE を抑制します。

34.1.1.1. 説明
リンクのコピー

34.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1SuppressCVERequest	X

34.1.1.5. レスポンス
リンクのコピー

Expand

表34.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

34.1.1.6. Samples
リンクのコピー

34.1.2. UnsuppressCVEs
リンクのコピー

PATCH /v1/imagecves/unsuppress

UnsuppressCVE はイメージの CVE を抑制解除します。

34.1.2.1. 説明
リンクのコピー

34.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UnsuppressCVERequest	X

34.1.2.5. レスポンス
リンクのコピー

Expand

表34.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

34.1.2.6. Samples
リンクのコピー

第35章 Image Integration Service
リンクのコピー

35.1. Image Integration Service
リンクのコピー

35.1.1. DeleteImageIntegration
リンクのコピー

DELETE /v1/imageintegrations/{id}

DeleteImageIntegration は、ID が指定されたイメージインテグレーションを削除します。

35.1.1.1. 説明
リンクのコピー

35.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

35.1.1.5. レスポンス
リンクのコピー

Expand

表35.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

35.1.1.6. Samples
リンクのコピー

35.1.2. GetImageIntegration
リンクのコピー

GET /v1/imageintegrations/{id}

GetImageIntegration は、ID が指定されている場合にイメージインテグレーションを返します。

35.1.2.1. 説明
リンクのコピー

35.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

35.1.2.5. レスポンス
リンクのコピー

Expand

表35.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageImageIntegration
0	予期しないエラーの応答。	GooglerpcStatus

35.1.2.6. Samples
リンクのコピー

35.1.3. GetImageIntegrations
リンクのコピー

GET /v1/imageintegrations

GetImageIntegrations は、リクエストフィルターに一致するすべてのイメージインテグレーションを返します。

35.1.3.1. 説明
リンクのコピー

35.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
name		-	null
cluster		-	null

35.1.3.5. レスポンス
リンクのコピー

Expand

表35.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetImageIntegrationsResponse
0	予期しないエラーの応答。	GooglerpcStatus

35.1.3.6. Samples
リンクのコピー

35.1.4. PostImageIntegration
リンクのコピー

POST /v1/imageintegrations

PostImageIntegration はイメージインテグレーションを作成します。

35.1.4.1. 説明
リンクのコピー

35.1.4.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageImageIntegration	X

35.1.4.5. レスポンス
リンクのコピー

Expand

表35.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageImageIntegration
0	予期しないエラーの応答。	GooglerpcStatus

35.1.4.6. Samples
リンクのコピー

35.1.5. PutImageIntegration
リンクのコピー

PUT /v1/imageintegrations/{id}

PutImageIntegration は、保存された認証情報の調整を使用せずに、指定されたイメージインテグレーションを変更します。

35.1.5.1. 説明
リンクのコピー

35.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

35.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ImageIntegrationServicePutImageIntegrationBody	X

35.1.5.5. レスポンス
リンクのコピー

Expand

表35.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

35.1.5.6. Samples
リンクのコピー

35.1.6. TestImageIntegration
リンクのコピー

POST /v1/imageintegrations/test

TestImageIntegration は、保存された認証情報の調整を使用せずに、指定されたイメージインテグレーションが正しく設定されているかどうかを確認します。

35.1.6.1. 説明
リンクのコピー

35.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageImageIntegration	X

35.1.6.5. レスポンス
リンクのコピー

Expand

表35.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

35.1.6.6. Samples
リンクのコピー

35.1.7. TestUpdatedImageIntegration
リンクのコピー

POST /v1/imageintegrations/test/updated

TestUpdatedImageIntegration は、オプションで保存された認証情報の調整を使用して、指定されたイメージインテグレーションが正しく設定されているかどうかを確認します。

35.1.7.1. 説明
リンクのコピー

35.1.7.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UpdateImageIntegrationRequest	X

35.1.7.5. レスポンス
リンクのコピー

Expand

表35.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

35.1.7.6. Samples
リンクのコピー

35.1.8. UpdateImageIntegration
リンクのコピー

PATCH /v1/imageintegrations/{config.id}

UpdateImageIntegration は、オプションで保存された認証情報の調整を使用して、指定されたイメージインテグレーションを変更します。

35.1.8.1. 説明
リンクのコピー

35.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
config.id		X	null

35.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ImageIntegrationServiceUpdateImageIntegrationBody	X

35.1.8.5. レスポンス
リンクのコピー

Expand

表35.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

35.1.8.6. Samples
リンクのコピー

第36章 Image サービス
リンクのコピー

36.1. Image サービス
リンクのコピー

36.1.1. CountImages
リンクのコピー

GET /v1/imagescount

CountImages は、入力クエリーに一致するイメージの数を返します。

36.1.1.1. 説明
リンクのコピー

36.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

36.1.1.5. レスポンス
リンクのコピー

Expand

表36.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountImagesResponse
0	予期しないエラーの応答。	GooglerpcStatus

36.1.1.6. Samples
リンクのコピー

36.1.2. DeleteImages
リンクのコピー

DELETE /v1/images

DeleteImage はクエリーに基づいてイメージを削除します

36.1.2.1. 説明
リンクのコピー

36.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null
confirm	-	null

36.1.2.5. レスポンス
リンクのコピー

Expand

表36.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeleteImagesResponse
0	予期しないエラーの応答。	GooglerpcStatus

36.1.2.6. Samples
リンクのコピー

36.1.3. ExportImages
リンクのコピー

GET /v1/export/images

36.1.3.1. 説明
リンクのコピー

36.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
timeout		-	null
query		-	null

36.1.3.5. レスポンス
リンクのコピー

Expand

表36.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	成功した応答です。(ストリーミング応答)	v1ExportImageResponse のストリーム結果。
0	予期しないエラーの応答。	GooglerpcStatus

36.1.3.6. Samples
リンクのコピー

36.1.4. GetImage
リンクのコピー

GET /v1/images/{id}

GetImage は、ID が指定されれている場合にイメージを返します。

36.1.4.1. 説明
リンクのコピー

36.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

36.1.4.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
includeSnoozed		-	null
stripDescription		-	null

36.1.4.5. レスポンス
リンクのコピー

Expand

表36.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageImage
0	予期しないエラーの応答。	GooglerpcStatus

36.1.4.6. Samples
リンクのコピー

36.1.5. GetWatchedImages
リンクのコピー

GET /v1/watchedimages

GetWatchedImages は現在監視されているイメージ名のリストを返します。

36.1.5.1. 説明
リンクのコピー

36.1.5.5. レスポンス
リンクのコピー

Expand

表36.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetWatchedImagesResponse
0	予期しないエラーの応答。	GooglerpcStatus

36.1.5.6. Samples
リンクのコピー

36.1.6. InvalidateScanAndRegistryCaches
リンクのコピー

GET /v1/images/cache/invalidate

InvalidateScanAndRegistryCaches はイメージメタデータキャッシュを削除します。

36.1.6.1. 説明
リンクのコピー

36.1.6.5. レスポンス
リンクのコピー

Expand

表36.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

36.1.6.6. Samples
リンクのコピー

36.1.7. ListImages
リンクのコピー

GET /v1/images

ListImages は入力クエリーに一致するすべてのイメージを返します。

36.1.7.1. 説明
リンクのコピー

36.1.7.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

36.1.7.5. レスポンス
リンクのコピー

Expand

表36.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListImagesResponse
0	予期しないエラーの応答。	GooglerpcStatus

36.1.7.6. Samples
リンクのコピー

36.1.8. ScanImage
リンクのコピー

POST /v1/images/scan

ScanImage は単一のイメージをスキャンし、結果を返します

36.1.8.1. 説明
リンクのコピー

36.1.8.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ScanImageRequest	X

36.1.8.5. レスポンス
リンクのコピー

Expand

表36.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageImage
0	予期しないエラーの応答。	GooglerpcStatus

36.1.8.6. Samples
リンクのコピー

36.1.9. UnwatchImage
リンクのコピー

DELETE /v1/watchedimages

UnwatchImage は、イメージ名を監視対象外としてマークします。イメージがすでに監視されていたかどうかに関係なく、呼び出し後にイメージが監視されなくなった場合は元の状態に戻ります。

36.1.9.1. 説明
リンクのコピー

36.1.9.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
name	The name of the image to unwatch.以前に監視したイメージの名前と一致する必要があります。	-	null

36.1.9.5. レスポンス
リンクのコピー

Expand

表36.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

36.1.9.6. Samples
リンクのコピー

36.1.10. WatchImage
リンクのコピー

POST /v1/watchedimages

WatchImage は、イメージ名を監視対象としてマークします。

36.1.10.1. 説明
リンクのコピー

36.1.10.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1WatchImageRequest	X

36.1.10.5. レスポンス
リンクのコピー

Expand

表36.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1WatchImageResponse
0	予期しないエラーの応答。	GooglerpcStatus

36.1.10.6. Samples
リンクのコピー

第37章 Integration Health Service
リンクのコピー

37.1. Integration Health Service
リンクのコピー

37.1.1. GetBackupPlugins
リンクのコピー

GET /v1/integrationhealth/externalbackups

37.1.1.1. 説明
リンクのコピー

37.1.1.5. レスポンス
リンクのコピー

Expand

表37.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetIntegrationHealthResponse
0	予期しないエラーの応答。	GooglerpcStatus

37.1.1.6. Samples
リンクのコピー

37.1.2. GetDeclarativeConfigs
リンクのコピー

GET /v1/integrationhealth/declarativeconfigs

37.1.2.1. 説明
リンクのコピー

37.1.2.5. レスポンス
リンクのコピー

Expand

表37.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetIntegrationHealthResponse
0	予期しないエラーの応答。	GooglerpcStatus

37.1.2.6. Samples
リンクのコピー

37.1.3. GetImageIntegrations
リンクのコピー

GET /v1/integrationhealth/imageintegrations

37.1.3.1. 説明
リンクのコピー

37.1.3.5. レスポンス
リンクのコピー

Expand

表37.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetIntegrationHealthResponse
0	予期しないエラーの応答。	GooglerpcStatus

37.1.3.6. Samples
リンクのコピー

37.1.4. GetNotifiers
リンクのコピー

GET /v1/integrationhealth/notifiers

37.1.4.1. 説明
リンクのコピー

37.1.4.5. レスポンス
リンクのコピー

Expand

表37.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetIntegrationHealthResponse
0	予期しないエラーの応答。	GooglerpcStatus

37.1.4.6. Samples
リンクのコピー

37.1.5. GetVulnDefinitionsInfo
リンクのコピー

GET /v1/integrationhealth/vulndefinitions

37.1.5.1. 説明
リンクのコピー

37.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
component		-	SCANNER

37.1.5.5. レスポンス
リンクのコピー

Expand

表37.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1VulnDefinitionsInfo
0	予期しないエラーの応答。	GooglerpcStatus

37.1.5.6. Samples
リンクのコピー

第38章 Listening Endpoints Service
リンクのコピー

38.1. Listening Endpoints Service
リンクのコピー

38.1.1. GetListeningEndpoints
リンクのコピー

GET /v1/listening_endpoints/deployment/{deploymentId}

GetListeningEndpoints は、指定されたデプロイメントに対してリスニングエンドポイントとそれを開いたプロセスを返します。

38.1.1.1. 説明
リンクのコピー

38.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

38.1.1.5. レスポンス
リンクのコピー

Expand

表38.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetProcessesListeningOnPortsResponse
0	予期しないエラーの応答。	GooglerpcStatus

38.1.1.6. Samples
リンクのコピー

第39章 Metadata Service
リンクのコピー

39.1. Metadata Service
リンクのコピー

39.1.1. GetCentralCapabilities
リンクのコピー

GET /v1/central-capabilities

39.1.1.1. 説明
リンクのコピー

39.1.1.5. レスポンス
リンクのコピー

Expand

表39.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CentralServicesCapabilities
0	予期しないエラーの応答。	GooglerpcStatus

39.1.1.6. Samples
リンクのコピー

39.1.2. GetDatabaseBackupStatus
リンクのコピー

GET /v1/backup/status

39.1.2.1. 説明
リンクのコピー

39.1.2.5. レスポンス
リンクのコピー

Expand

表39.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DatabaseBackupStatus
0	予期しないエラーの応答。	GooglerpcStatus

39.1.2.6. Samples
リンクのコピー

39.1.3. GetDatabaseStatus
リンクのコピー

GET /v1/database/status

39.1.3.1. 説明
リンクのコピー

39.1.3.5. レスポンス
リンクのコピー

Expand

表39.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DatabaseStatus
0	予期しないエラーの応答。	GooglerpcStatus

39.1.3.6. Samples
リンクのコピー

39.1.4. GetMetadata
リンクのコピー

GET /v1/metadata

39.1.4.1. 説明
リンクのコピー

39.1.4.5. レスポンス
リンクのコピー

Expand

表39.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1Metadata
0	予期しないエラーの応答。	GooglerpcStatus

39.1.4.6. Samples
リンクのコピー

39.1.5. TLSChallenge
リンクのコピー

GET /v1/tls-challenge

TLSChallenge

39.1.5.1. 説明
リンクのコピー

すべての信頼された CA、つまり secret/additional-ca と Central の証明書チェーンを返します。これは、Central が自己署名証明書を持つロードバランサーの背後で実行されている場合に必要です。認証は必要ありません。

39.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
challengeToken	TLS 証明書を要求するサービスによって生成されたチャレンジトークン	-	null

39.1.5.5. レスポンス
リンクのコピー

Expand

表39.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1TLSChallengeResponse
0	予期しないエラーの応答。	GooglerpcStatus

39.1.5.6. Samples
リンクのコピー

第40章 Mitre Attack Service
リンクのコピー

40.1. Mitre Attack Service
リンクのコピー

40.1.1. GetMitreAttackVector
リンクのコピー

GET /v1/mitreattackvectors/{id}

GetMitreAttackVector は、全テクニックを含むタクティックの完全な MITRE ATT&CK ベクトルを返します。

40.1.1.1. 説明
リンクのコピー

40.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

40.1.1.5. レスポンス
リンクのコピー

Expand

表40.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetMitreVectorResponse
0	予期しないエラーの応答。	GooglerpcStatus

40.1.1.6. Samples
リンクのコピー

40.1.2. ListMitreAttackVectors
リンクのコピー

GET /v1/mitreattackvectors

ListMitreAttackVectors は、すべての MITRE ATT&CK ベクトルを返します。

40.1.2.1. 説明
リンクのコピー

40.1.2.5. レスポンス
リンクのコピー

Expand

表40.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListMitreAttackVectorsResponse
0	予期しないエラーの応答。	GooglerpcStatus

40.1.2.6. Samples
リンクのコピー

第41章 Namespace Service
リンクのコピー

41.1. Namespace Service
リンクのコピー

41.1.1. GetNamespace
リンクのコピー

GET /v1/namespaces/{id}

41.1.1.1. 説明
リンクのコピー

41.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

41.1.1.5. レスポンス
リンクのコピー

Expand

表41.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1Namespace
0	予期しないエラーの応答。	GooglerpcStatus

41.1.1.6. Samples
リンクのコピー

41.1.2. GetNamespaces
リンクのコピー

GET /v1/namespaces

41.1.2.1. 説明
リンクのコピー

41.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query.query	-	null
query.pagination.limit	-	null
query.pagination.offset	-	null
query.pagination.sortOption.field	-	null
query.pagination.sortOption.reversed	-	null
query.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

41.1.2.5. レスポンス
リンクのコピー

Expand

表41.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetNamespacesResponse
0	予期しないエラーの応答。	GooglerpcStatus

41.1.2.6. Samples
リンクのコピー

第42章 Network Baseline Service
リンクのコピー

42.1. Network Baseline Service
リンクのコピー

42.1.1. GetNetworkBaseline
リンクのコピー

GET /v1/networkbaseline/{id}

42.1.1.1. 説明
リンクのコピー

42.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

42.1.1.5. レスポンス
リンクのコピー

Expand

表42.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkBaseline
0	予期しないエラーの応答。	GooglerpcStatus

42.1.1.6. Samples
リンクのコピー

42.1.2. GetNetworkBaselineStatusForFlows
リンクのコピー

POST /v1/networkbaseline/{deploymentId}/status

42.1.2.1. 説明
リンクのコピー

42.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

42.1.2.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkBaselineServiceGetNetworkBaselineStatusForFlowsBody	X

42.1.2.5. レスポンス
リンクのコピー

Expand

表42.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1NetworkBaselineStatusResponse
0	予期しないエラーの応答。	GooglerpcStatus

42.1.2.6. Samples
リンクのコピー

42.1.3. LockNetworkBaseline
リンクのコピー

PATCH /v1/networkbaseline/{id}/lock

42.1.3.1. 説明
リンクのコピー

42.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

42.1.3.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	`object`	X

42.1.3.5. レスポンス
リンクのコピー

Expand

表42.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

42.1.3.6. Samples
リンクのコピー

42.1.4. ModifyBaselineStatusForPeers
リンクのコピー

PATCH /v1/networkbaseline/{deploymentId}/peers

42.1.4.1. 説明
リンクのコピー

42.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

42.1.4.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkBaselineServiceModifyBaselineStatusForPeersBody	X

42.1.4.5. レスポンス
リンクのコピー

Expand

表42.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

42.1.4.6. Samples
リンクのコピー

42.1.5. UnlockNetworkBaseline
リンクのコピー

PATCH /v1/networkbaseline/{id}/unlock

42.1.5.1. 説明
リンクのコピー

42.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

42.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	`object`	X

42.1.5.5. レスポンス
リンクのコピー

Expand

表42.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

42.1.5.6. Samples
リンクのコピー

第43章 Network Graph Service
リンクのコピー

43.1. Network Graph Service
リンクのコピー

43.1.1. CreateExternalNetworkEntity
リンクのコピー

POST /v1/networkgraph/cluster/{clusterId}/externalentities

43.1.1.1. 説明
リンクのコピー

43.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

43.1.1.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkGraphServiceCreateExternalNetworkEntityBody	X

43.1.1.5. レスポンス
リンクのコピー

Expand

表43.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkEntity
0	予期しないエラーの応答。	GooglerpcStatus

43.1.1.6. Samples
リンクのコピー

43.1.2. DeleteExternalNetworkEntity
リンクのコピー

DELETE /v1/networkgraph/externalentities/{id}

43.1.2.1. 説明
リンクのコピー

43.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

43.1.2.5. レスポンス
リンクのコピー

Expand

表43.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

43.1.2.6. Samples
リンクのコピー

43.1.3. GetExternalNetworkEntities
リンクのコピー

GET /v1/networkgraph/cluster/{clusterId}/externalentities

43.1.3.1. 説明
リンクのコピー

43.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

43.1.3.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
query		-	null

43.1.3.5. レスポンス
リンクのコピー

Expand

表43.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetExternalNetworkEntitiesResponse
0	予期しないエラーの応答。	GooglerpcStatus

43.1.3.6. Samples
リンクのコピー

43.1.4. GetExternalNetworkFlows
リンクのコピー

GET /v1/networkgraph/cluster/{clusterId}/externalentities/{entityId}/flows

43.1.4.1. 説明
リンクのコピー

43.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null
entityId		X	null

43.1.4.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
since	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

43.1.4.5. レスポンス
リンクのコピー

Expand

表43.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetExternalNetworkFlowsResponse
0	予期しないエラーの応答。	GooglerpcStatus

43.1.4.6. Samples
リンクのコピー

43.1.5. GetExternalNetworkFlowsMetadata
リンクのコピー

GET /v1/networkgraph/cluster/{clusterId}/externalentities/metadata

43.1.5.1. 説明
リンクのコピー

43.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

43.1.5.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
since	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

43.1.5.3. 戻り値のタイプ
リンクのコピー

V1GetExternalNetworkFlowsMetadataResponse

43.1.5.5. レスポンス
リンクのコピー

Expand

表43.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetExternalNetworkFlowsMetadataResponse
0	予期しないエラーの応答。	GooglerpcStatus

43.1.5.6. Samples
リンクのコピー

43.1.6. GetNetworkGraph
リンクのコピー

GET /v1/networkgraph/cluster/{clusterId}

43.1.6.1. 説明
リンクのコピー

43.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

43.1.6.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
since	-	null
includePorts	-	null
scope.query	-	null
includePolicies	-	null

43.1.6.5. レスポンス
リンクのコピー

Expand

表43.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1NetworkGraph
0	予期しないエラーの応答。	GooglerpcStatus

43.1.6.6. Samples
リンクのコピー

43.1.7. GetNetworkGraphConfig
リンクのコピー

GET /v1/networkgraph/config

43.1.7.1. 説明
リンクのコピー

43.1.7.5. レスポンス
リンクのコピー

Expand

表43.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkGraphConfig
0	予期しないエラーの応答。	GooglerpcStatus

43.1.7.6. Samples
リンクのコピー

43.1.8. PatchExternalNetworkEntity
リンクのコピー

PATCH /v1/networkgraph/externalentities/{id}

43.1.8.1. 説明
リンクのコピー

43.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

43.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkGraphServicePatchExternalNetworkEntityBody	X

43.1.8.5. レスポンス
リンクのコピー

Expand

表43.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkEntity
0	予期しないエラーの応答。	GooglerpcStatus

43.1.8.6. Samples
リンクのコピー

43.1.9. PutNetworkGraphConfig
リンクのコピー

PUT /v1/networkgraph/config

43.1.9.1. 説明
リンクのコピー

43.1.9.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1PutNetworkGraphConfigRequest	X

43.1.9.5. レスポンス
リンクのコピー

Expand

表43.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkGraphConfig
0	予期しないエラーの応答。	GooglerpcStatus

43.1.9.6. Samples
リンクのコピー

第44章 Network Policy Service
リンクのコピー

44.1. Network Policy Service
リンクのコピー

44.1.1. ApplyNetworkPolicy
リンクのコピー

POST /v1/networkpolicies/apply/{clusterId}

44.1.1.1. 説明
リンクのコピー

44.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.1.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
modification	StorageNetworkPolicyModification	X

44.1.1.5. レスポンス
リンクのコピー

Expand

表44.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

44.1.1.6. Samples
リンクのコピー

44.1.2. ApplyNetworkPolicyYamlForDeployment
リンクのコピー

POST /v1/networkpolicies/apply/deployment/{deploymentId}

44.1.2.1. 説明
リンクのコピー

44.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

44.1.2.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkPolicyServiceApplyNetworkPolicyYamlForDeploymentBody	X

44.1.2.5. レスポンス
リンクのコピー

Expand

表44.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

44.1.2.6. Samples
リンクのコピー

44.1.3. GenerateNetworkPolicies
リンクのコピー

GET /v1/networkpolicies/generate/{clusterId}

44.1.3.1. 説明
リンクのコピー

44.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.3.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
query		-	null
deleteExisting	- NONE: 既存のネットワークポリシーを削除しません。- GENERATED_ONLY: 自動生成された既存のネットワークポリシーを削除します。- ALL: それぞれの namespace 内の既存のネットワークポリシーをすべて削除します。	-	UNKNOWN
networkDataSince		-	null
includePorts		-	null

44.1.3.5. レスポンス
リンクのコピー

Expand

表44.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GenerateNetworkPoliciesResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.3.6. Samples
リンクのコピー

44.1.4. GetAllowedPeersFromCurrentPolicyForDeployment
リンクのコピー

GET /v1/networkpolicies/allowedpeers/{id}

44.1.4.1. 説明
リンクのコピー

44.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

44.1.4.3. 戻り値のタイプ
リンクのコピー

V1GetAllowedPeersFromCurrentPolicyForDeploymentResponse

44.1.4.5. レスポンス
リンクのコピー

Expand

表44.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAllowedPeersFromCurrentPolicyForDeploymentResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.4.6. Samples
リンクのコピー

44.1.5. GetBaselineGeneratedNetworkPolicyForDeployment
リンクのコピー

POST /v1/networkpolicies/generate/baseline/{deploymentId}

44.1.5.1. 説明
リンクのコピー

44.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

44.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NetworkPolicyServiceGetBaselineGeneratedNetworkPolicyForDeploymentBody	X

44.1.5.3. 戻り値のタイプ
リンクのコピー

V1GetBaselineGeneratedPolicyForDeploymentResponse

44.1.5.5. レスポンス
リンクのコピー

Expand

表44.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetBaselineGeneratedPolicyForDeploymentResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.5.6. Samples
リンクのコピー

44.1.6. GetDiffFlowsBetweenPolicyAndBaselineForDeployment
リンクのコピー

GET /v1/networkpolicies/baselinecomparison/{id}

44.1.6.1. 説明
リンクのコピー

44.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

44.1.6.5. レスポンス
リンクのコピー

Expand

表44.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDiffFlowsResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.6.6. Samples
リンクのコピー

44.1.7. GetDiffFlowsFromUndoModificationForDeployment
リンクのコピー

GET /v1/networkpolicies/undobaselinecomparison/{id}

44.1.7.1. 説明
リンクのコピー

44.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

44.1.7.5. レスポンス
リンクのコピー

Expand

表44.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetDiffFlowsResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.7.6. Samples
リンクのコピー

44.1.8. GetNetworkGraph
リンクのコピー

GET /v1/networkpolicies/cluster/{clusterId}

44.1.8.1. 説明
リンクのコピー

44.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.8.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
query		-	null
includePorts	true に設定すると、ネットワークポリシーグラフにポートレベルの情報が含まれます。	-	null
scope.query		-	null

44.1.8.5. レスポンス
リンクのコピー

Expand

表44.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1NetworkGraph
0	予期しないエラーの応答。	GooglerpcStatus

44.1.8.6. Samples
リンクのコピー

44.1.9. GetNetworkGraphEpoch
リンクのコピー

GET /v1/networkpolicies/graph/epoch

44.1.9.1. 説明
リンクのコピー

44.1.9.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		-	null

44.1.9.5. レスポンス
リンクのコピー

Expand

表44.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1NetworkGraphEpoch
0	予期しないエラーの応答。	GooglerpcStatus

44.1.9.6. Samples
リンクのコピー

44.1.10. GetNetworkPolicies
リンクのコピー

GET /v1/networkpolicies

44.1.10.1. 説明
リンクのコピー

44.1.10.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
clusterId	-	null
deploymentQuery	-	null
namespace	-	null

44.1.10.5. レスポンス
リンクのコピー

Expand

表44.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1NetworkPoliciesResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.10.6. Samples
リンクのコピー

44.1.11. GetNetworkPolicy
リンクのコピー

GET /v1/networkpolicies/{id}

44.1.11.1. 説明
リンクのコピー

44.1.11.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

44.1.11.5. レスポンス
リンクのコピー

Expand

表44.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNetworkPolicy
0	予期しないエラーの応答。	GooglerpcStatus

44.1.11.6. Samples
リンクのコピー

44.1.12. GetUndoModification
リンクのコピー

GET /v1/networkpolicies/undo/{clusterId}

44.1.12.1. 説明
リンクのコピー

44.1.12.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.12.5. レスポンス
リンクのコピー

Expand

表44.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetUndoModificationResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.12.6. Samples
リンクのコピー

44.1.13. GetUndoModificationForDeployment
リンクのコピー

GET /v1/networkpolicies/undo/deployment/{id}

44.1.13.1. 説明
リンクのコピー

44.1.13.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

44.1.13.3. 戻り値のタイプ
リンクのコピー

V1GetUndoModificationForDeploymentResponse

44.1.13.5. レスポンス
リンクのコピー

Expand

表44.13 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetUndoModificationForDeploymentResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.13.6. Samples
リンクのコピー

44.1.14. SendNetworkPolicyYAML
リンクのコピー

POST /v1/networkpolicies/simulate/{clusterId}/notify

44.1.14.1. 説明
リンクのコピー

44.1.14.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.14.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
modification	StorageNetworkPolicyModification	X

44.1.14.2.3. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
notifierIds	`String`	-	null

44.1.14.5. レスポンス
リンクのコピー

Expand

表44.14 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

44.1.14.6. Samples
リンクのコピー

44.1.15. SimulateNetworkGraph
リンクのコピー

POST /v1/networkpolicies/simulate/{clusterId}

44.1.15.1. 説明
リンクのコピー

44.1.15.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

44.1.15.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
modification	StorageNetworkPolicyModification	X

44.1.15.2.3. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
query		-	null
includePorts	true に設定すると、ネットワークポリシーグラフにポートレベルの情報が含まれます。	-	null
includeNodeDiff		-	null
scope.query		-	null

44.1.15.5. レスポンス
リンクのコピー

Expand

表44.15 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1SimulateNetworkGraphResponse
0	予期しないエラーの応答。	GooglerpcStatus

44.1.15.6. Samples
リンクのコピー

第45章 Node CVEService
リンクのコピー

45.1. Node C V E Service
リンクのコピー

45.1.1. SuppressCVEs
リンクのコピー

PATCH /v1/nodecves/suppress

SuppressCVE はノード CVE を抑制します。

45.1.1.1. 説明
リンクのコピー

45.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1SuppressCVERequest	X

45.1.1.5. レスポンス
リンクのコピー

Expand

表45.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

45.1.1.6. Samples
リンクのコピー

45.1.2. UnsuppressCVEs
リンクのコピー

PATCH /v1/nodecves/unsuppress

UnsuppressCVE はノード CVE を抑制解除します。

45.1.2.1. 説明
リンクのコピー

45.1.2.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UnsuppressCVERequest	X

45.1.2.5. レスポンス
リンクのコピー

Expand

表45.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

45.1.2.6. Samples
リンクのコピー

第46章 Node Service
リンクのコピー

46.1. Node Service
リンクのコピー

46.1.1. ExportNodes
リンクのコピー

GET /v1/export/nodes

46.1.1.1. 説明
リンクのコピー

46.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
timeout		-	null
query		-	null

46.1.1.5. レスポンス
リンクのコピー

Expand

表46.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	成功した応答です。(ストリーミング応答)	v1ExportNodeResponse のストリーム結果。
0	予期しないエラーの応答。	GooglerpcStatus

46.1.1.6. Samples
リンクのコピー

46.1.2. GetNode
リンクのコピー

GET /v1/nodes/{clusterId}/{nodeId}

46.1.2.1. 説明
リンクのコピー

46.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null
nodeId		X	null

46.1.2.5. レスポンス
リンクのコピー

Expand

表46.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNode
0	予期しないエラーの応答。	GooglerpcStatus

46.1.2.6. Samples
リンクのコピー

46.1.3. ListNodes
リンクのコピー

GET /v1/nodes/{clusterId}

46.1.3.1. 説明
リンクのコピー

46.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

46.1.3.5. レスポンス
リンクのコピー

Expand

表46.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListNodesResponse
0	予期しないエラーの応答。	GooglerpcStatus

46.1.3.6. Samples
リンクのコピー

第47章 Notifier Service
リンクのコピー

47.1. Notifier Service
リンクのコピー

47.1.1. DeleteNotifier
リンクのコピー

DELETE /v1/notifiers/{id}

DeleteNotifier は、ID が指定されている場合に通知設定を削除します。

47.1.1.1. 説明
リンクのコピー

47.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

47.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
force		-	null

47.1.1.5. レスポンス
リンクのコピー

Expand

表47.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

47.1.1.6. Samples
リンクのコピー

47.1.2. GetNotifier
リンクのコピー

GET /v1/notifiers/{id}

GetNotifier は、ID が指定されている場合に通知設定を返します。

47.1.2.1. 説明
リンクのコピー

47.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

47.1.2.5. レスポンス
リンクのコピー

Expand

表47.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNotifier
0	予期しないエラーの応答。	GooglerpcStatus

47.1.2.6. Samples
リンクのコピー

47.1.3. GetNotifiers
リンクのコピー

GET /v1/notifiers

GetNotifiers はすべての通知設定を返します。

47.1.3.1. 説明
リンクのコピー

47.1.3.5. レスポンス
リンクのコピー

Expand

表47.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetNotifiersResponse
0	予期しないエラーの応答。	GooglerpcStatus

47.1.3.6. Samples
リンクのコピー

47.1.4. PostNotifier
リンクのコピー

POST /v1/notifiers

PostNotifier は通知設定を作成します。

47.1.4.1. 説明
リンクのコピー

47.1.4.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageNotifier	X

47.1.4.5. レスポンス
リンクのコピー

Expand

表47.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageNotifier
0	予期しないエラーの応答。	GooglerpcStatus

47.1.4.6. Samples
リンクのコピー

47.1.5. PutNotifier
リンクのコピー

PUT /v1/notifiers/{id}

PutNotifier は、保存された認証情報の調整を使用せずに、指定された通知機能を変更します。

47.1.5.1. 説明
リンクのコピー

47.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

47.1.5.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NotifierServicePutNotifierBody	X

47.1.5.5. レスポンス
リンクのコピー

Expand

表47.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

47.1.5.6. Samples
リンクのコピー

47.1.6. TestNotifier
リンクのコピー

POST /v1/notifiers/test

TestNotifier は、通知機能が正しく設定されているかどうかを確認します。

47.1.6.1. 説明
リンクのコピー

47.1.6.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StorageNotifier	X

47.1.6.5. レスポンス
リンクのコピー

Expand

表47.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

47.1.6.6. Samples
リンクのコピー

47.1.7. TestUpdatedNotifier
リンクのコピー

POST /v1/notifiers/test/updated

TestUpdatedNotifier は、オプションで保存された認証情報の調整を使用して、指定された通知機能が正しく設定されているかどうかを確認します。

47.1.7.1. 説明
リンクのコピー

47.1.7.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UpdateNotifierRequest	X

47.1.7.5. レスポンス
リンクのコピー

Expand

表47.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

47.1.7.6. Samples
リンクのコピー

47.1.8. UpdateNotifier
リンクのコピー

PATCH /v1/notifiers/{notifier.id}

UpdateNotifier は、オプションで保存された認証情報の調整を使用して、指定された通知機能を変更します。

47.1.8.1. 説明
リンクのコピー

47.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
notifier.id		X	null

47.1.8.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	NotifierServiceUpdateNotifierBody	X

47.1.8.5. レスポンス
リンクのコピー

Expand

表47.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

47.1.8.6. Samples
リンクのコピー

第48章 Ping Service
リンクのコピー

48.1. Ping Service
リンクのコピー

48.1.1. Ping
リンクのコピー

GET /v1/ping

48.1.1.1. 説明
リンクのコピー

48.1.1.5. レスポンス
リンクのコピー

Expand

表48.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PongMessage
0	予期しないエラーの応答。	GooglerpcStatus

48.1.1.6. Samples
リンクのコピー

第49章 Pod Service
リンクのコピー

49.1. Pod Service
リンクのコピー

49.1.1. ExportPods
リンクのコピー

GET /v1/export/pods

49.1.1.1. 説明
リンクのコピー

49.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
timeout		-	null
query		-	null

49.1.1.5. レスポンス
リンクのコピー

Expand

表49.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	成功した応答です。(ストリーミング応答)	v1ExportPodResponse のストリーム結果。
0	予期しないエラーの応答。	GooglerpcStatus

49.1.1.6. Samples
リンクのコピー

49.1.2. GetPods
リンクのコピー

GET /v1/pods

GetPods は Pod を返します。

49.1.2.1. 説明
リンクのコピー

49.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

49.1.2.5. レスポンス
リンクのコピー

Expand

表49.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PodsResponse
0	予期しないエラーの応答。	GooglerpcStatus

49.1.2.6. Samples
リンクのコピー

第50章 Policy Category Service
リンクのコピー

50.1. Policy Category Service
リンクのコピー

50.1.1. DeletePolicyCategory
リンクのコピー

DELETE /v1/policycategories/{id}

DeletePolicyCategory は指定されたポリシーカテゴリーを削除します。

50.1.1.1. 説明
リンクのコピー

50.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

50.1.1.5. レスポンス
リンクのコピー

Expand

表50.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

50.1.1.6. Samples
リンクのコピー

50.1.2. GetPolicyCategories
リンクのコピー

GET /v1/policycategories

GetPolicyCategories はポリシーカテゴリーのリストを返します

50.1.2.1. 説明
リンクのコピー

50.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

50.1.2.5. レスポンス
リンクのコピー

Expand

表50.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetPolicyCategoriesResponse
0	予期しないエラーの応答。	GooglerpcStatus

50.1.2.6. Samples
リンクのコピー

50.1.3. GetPolicyCategory
リンクのコピー

GET /v1/policycategories/{id}

GetPolicyCategory は、ID によって要求されたポリシーカテゴリーを返します。

50.1.3.1. 説明
リンクのコピー

50.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

50.1.3.5. レスポンス
リンクのコピー

Expand

表50.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PolicyCategory
0	予期しないエラーの応答。	GooglerpcStatus

50.1.3.6. Samples
リンクのコピー

50.1.4. PostPolicyCategory
リンクのコピー

POST /v1/policycategories

PostPolicyCategory は新しいポリシーカテゴリーを作成します

50.1.4.1. 説明
リンクのコピー

50.1.4.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
policyCategory	V1PolicyCategory	X

50.1.4.5. レスポンス
リンクのコピー

Expand

表50.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PolicyCategory
0	予期しないエラーの応答。	GooglerpcStatus

50.1.4.6. Samples
リンクのコピー

50.1.5. RenamePolicyCategory
リンクのコピー

PUT /v1/policycategories

RenamePolicyCategory は、指定されたポリシーカテゴリーの名前を変更します。

50.1.5.1. 説明
リンクのコピー

50.1.5.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1RenamePolicyCategoryRequest	X

50.1.5.5. レスポンス
リンクのコピー

Expand

表50.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PolicyCategory
0	予期しないエラーの応答。	GooglerpcStatus

50.1.5.6. Samples
リンクのコピー

第51章 Policy Service
リンクのコピー

51.1. Policy Service
リンクのコピー

51.1.1. CancelDryRunJob
リンクのコピー

DELETE /v1/policies/dryrunjob/{jobId}

51.1.1.1. 説明
リンクのコピー

51.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
jobId		X	null

51.1.1.5. レスポンス
リンクのコピー

Expand

表51.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.1.6. Samples
リンクのコピー

51.1.2. DeletePolicy
リンクのコピー

DELETE /v1/policies/{id}

DeletePolicy は ID によってポリシーを削除します。

51.1.2.1. 説明
リンクのコピー

51.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

51.1.2.5. レスポンス
リンクのコピー

Expand

表51.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.2.6. Samples
リンクのコピー

51.1.3. DryRunPolicy
リンクのコピー

POST /v1/policies/dryrun

DryRunPolicy は指定されたポリシーを評価し、ポリシーを作成せずにアラートを返します。

51.1.3.1. 説明
リンクのコピー

51.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StoragePolicy	X

51.1.3.5. レスポンス
リンクのコピー

Expand

表51.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DryRunResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.3.6. Samples
リンクのコピー

51.1.4. EnableDisablePolicyNotification
リンクのコピー

PATCH /v1/policies/{policyId}/notifiers

EnableDisablePolicyNotification は、ID によってポリシーの通知を有効または無効にします。

51.1.4.1. 説明
リンクのコピー

51.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
policyId		X	null

51.1.4.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	PolicyServiceEnableDisablePolicyNotificationBody	X

51.1.4.5. レスポンス
リンクのコピー

Expand

表51.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.4.6. Samples
リンクのコピー

51.1.5. ExportPolicies
リンクのコピー

POST /v1/policies/export

ExportPolicies はポリシー ID のリストを受け取り、ポリシーのリスト全体またはエラーメッセージを返します。

51.1.5.1. 説明
リンクのコピー

51.1.5.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ExportPoliciesRequest	X

51.1.5.5. レスポンス
リンクのコピー

Expand

表51.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageExportPoliciesResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.5.6. Samples
リンクのコピー

51.1.6. GetPolicy
リンクのコピー

GET /v1/policies/{id}

GetPolicy は、ID によって要求されたポリシーを返します。

51.1.6.1. 説明
リンクのコピー

51.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

51.1.6.5. レスポンス
リンクのコピー

Expand

表51.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePolicy
0	予期しないエラーの応答。	GooglerpcStatus

51.1.6.6. Samples
リンクのコピー

51.1.7. GetPolicyCategories
リンクのコピー

GET /v1/policyCategories

GetPolicyCategories はポリシーカテゴリーを返します。

51.1.7.1. 説明
リンクのコピー

51.1.7.5. レスポンス
リンクのコピー

Expand

表51.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PolicyCategoriesResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.7.6. Samples
リンクのコピー

51.1.8. GetPolicyMitreVectors
リンクのコピー

GET /v1/policies/{id}/mitrevectors

GetMitreVectorsForPolicy は、ID によって要求されたポリシーを返します。

51.1.8.1. 説明
リンクのコピー

51.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

51.1.8.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
options.excludePolicy	true に設定すると、ポリシーは応答から除外されます。	-	null

51.1.8.5. レスポンス
リンクのコピー

Expand

表51.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetPolicyMitreVectorsResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.8.6. Samples
リンクのコピー

51.1.9. ImportPolicies
リンクのコピー

POST /v1/policies/import

ImportPolicies はポリシーのリストを受け取り、インポートできなかったポリシーのリストを返します。

51.1.9.1. 説明
リンクのコピー

51.1.9.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1ImportPoliciesRequest	X

51.1.9.5. レスポンス
リンクのコピー

Expand

表51.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ImportPoliciesResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.9.6. Samples
リンクのコピー

51.1.10. ListPolicies
リンクのコピー

GET /v1/policies

ListPolicies はポリシーのリストを返します。

51.1.10.1. 説明
リンクのコピー

51.1.10.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

51.1.10.5. レスポンス
リンクのコピー

Expand

表51.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListPoliciesResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.10.6. Samples
リンクのコピー

51.1.11. PatchPolicy
リンクのコピー

PATCH /v1/policies/{id}

PatchPolicy は既存のポリシーを編集します。

51.1.11.1. 説明
リンクのコピー

51.1.11.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

51.1.11.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	PolicyServicePatchPolicyBody	X

51.1.11.5. レスポンス
リンクのコピー

Expand

表51.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.11.6. Samples
リンクのコピー

51.1.12. PolicyFromSearch
リンクのコピー

POST /v1/policies/from-search

51.1.12.1. 説明
リンクのコピー

51.1.12.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1PolicyFromSearchRequest	X

51.1.12.5. レスポンス
リンクのコピー

Expand

表51.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PolicyFromSearchResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.12.6. Samples
リンクのコピー

51.1.13. PostPolicy
リンクのコピー

POST /v1/policies

PostPolicy は新しいポリシーを作成します。

51.1.13.1. 説明
リンクのコピー

51.1.13.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
policy	StoragePolicy	X

51.1.13.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
enableStrictValidation		-	null

51.1.13.5. レスポンス
リンクのコピー

Expand

表51.13 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePolicy
0	予期しないエラーの応答。	GooglerpcStatus

51.1.13.6. Samples
リンクのコピー

51.1.14. PutPolicy
リンクのコピー

PUT /v1/policies/{id}

PutPolicy は既存のポリシーを変更します。

51.1.14.1. 説明
リンクのコピー

51.1.14.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

51.1.14.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	PolicyServicePutPolicyBody	X

51.1.14.5. レスポンス
リンクのコピー

Expand

表51.14 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.14.6. Samples
リンクのコピー

51.1.15. QueryDryRunJobStatus
リンクのコピー

GET /v1/policies/dryrunjob/{jobId}

51.1.15.1. 説明
リンクのコピー

51.1.15.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
jobId		X	null

51.1.15.5. レスポンス
リンクのコピー

Expand

表51.15 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DryRunJobStatusResponse
0	予期しないエラーの応答。	GooglerpcStatus

51.1.15.6. Samples
リンクのコピー

51.1.16. ReassessPolicies
リンクのコピー

POST /v1/policies/reassess

ReassessPolicies はすべてのポリシーを再評価します。

51.1.16.1. 説明
リンクのコピー

51.1.16.5. レスポンス
リンクのコピー

Expand

表51.16 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

51.1.16.6. Samples
リンクのコピー

51.1.17. SubmitDryRunPolicyJob
リンクのコピー

POST /v1/policies/dryrunjob

51.1.17.1. 説明
リンクのコピー

51.1.17.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	StoragePolicy	X

51.1.17.5. レスポンス
リンクのコピー

Expand

表51.17 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1JobId
0	予期しないエラーの応答。	GooglerpcStatus

51.1.17.6. Samples
リンクのコピー

第52章 Probe Upload Service
リンクのコピー

52.1. Probe Upload Service
リンクのコピー

52.1.1. GetExistingProbes
リンクのコピー

POST /v1/probeupload/getexisting

52.1.1.1. 説明
リンクのコピー

52.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
filesToCheck	`String`	-	null

52.1.1.5. レスポンス
リンクのコピー

Expand

表52.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetExistingProbesResponse
0	予期しないエラーの応答。	GooglerpcStatus

52.1.1.6. Samples
リンクのコピー

第53章 Process Baseline Service
リンクのコピー

53.1. Process Baseline Service
リンクのコピー

53.1.1. DeleteProcessBaselines
リンクのコピー

DELETE /v1/processbaselines

DeleteProcessBaselines はベースラインを削除します。

53.1.1.1. 説明
リンクのコピー

53.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
query		-	null
confirm		-	null

53.1.1.5. レスポンス
リンクのコピー

Expand

表53.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeleteProcessBaselinesResponse
0	予期しないエラーの応答。	GooglerpcStatus

53.1.1.6. Samples
リンクのコピー

53.1.2. GetProcessBaseline
リンクのコピー

GET /v1/processbaselines/key

GetProcessBaselineById は、指定された ID で参照される単一のプロセスベースラインを返します。

53.1.2.1. 説明
リンクのコピー

53.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
key.deploymentId	キーを柔軟性を持たせることが目的です。これらの特定の組み合わせのみがサポートされます。	-	null
key.containerName		-	null
key.clusterId		-	null
key.namespace		-	null

53.1.2.5. レスポンス
リンクのコピー

Expand

表53.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageProcessBaseline
0	予期しないエラーの応答。	GooglerpcStatus

53.1.2.6. Samples
リンクのコピー

53.1.3. LockProcessBaselines
リンクのコピー

PUT /v1/processbaselines/lock

LockProcessBaselines は、 ベースライン ID のリストを受け取り、それらのベースラインをロックし、更新されたベースラインオブジェクトを返します。

53.1.3.1. 説明
リンクのコピー

53.1.3.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1LockProcessBaselinesRequest	X

53.1.3.5. レスポンス
リンクのコピー

Expand

表53.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1UpdateProcessBaselinesResponse
0	予期しないエラーの応答。	GooglerpcStatus

53.1.3.6. Samples
リンクのコピー

53.1.4. UpdateProcessBaselines
リンクのコピー

PUT /v1/processbaselines

AddToProcessBaselines は、プロセスベースラインの各リストにプロセス名のリストを追加します。

53.1.4.1. 説明
リンクのコピー

53.1.4.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1UpdateProcessBaselinesRequest	X

53.1.4.5. レスポンス
リンクのコピー

Expand

表53.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1UpdateProcessBaselinesResponse
0	予期しないエラーの応答。	GooglerpcStatus

53.1.4.6. Samples
リンクのコピー

第54章 Process Service
リンクのコピー

54.1. Process Service
リンクのコピー

54.1.1. CountProcesses
リンクのコピー

GET /v1/processcount

CountProcesses はプロセスの数を返します。

54.1.1.1. 説明
リンクのコピー

54.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

54.1.1.5. レスポンス
リンクのコピー

Expand

表54.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountProcessesResponse
0	予期しないエラーの応答。	GooglerpcStatus

54.1.1.6. Samples
リンクのコピー

54.1.2. GetGroupedProcessByDeployment
リンクのコピー

GET /v1/processes/deployment/{deploymentId}/grouped

GetGroupedProcessByDeployment は、実行されたすべてのプロセスをデプロイメントごとに分類して返します。

54.1.2.1. 説明
リンクのコピー

54.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

54.1.2.5. レスポンス
リンクのコピー

Expand

表54.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetGroupedProcessesResponse
0	予期しないエラーの応答。	GooglerpcStatus

54.1.2.6. Samples
リンクのコピー

54.1.3. GetGroupedProcessByDeploymentAndContainer
リンクのコピー

GET /v1/processes/deployment/{deploymentId}/grouped/container

GetGroupedProcessByDeploymentAndContainer は、実行されたすべてのプロセスを、デプロイメントおよびコンテナー別に分類して返します。

54.1.3.1. 説明
リンクのコピー

54.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

54.1.3.3. 戻り値のタイプ
リンクのコピー

V1GetGroupedProcessesWithContainerResponse

54.1.3.5. レスポンス
リンクのコピー

Expand

表54.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetGroupedProcessesWithContainerResponse
0	予期しないエラーの応答。	GooglerpcStatus

54.1.3.6. Samples
リンクのコピー

54.1.4. GetProcessesByDeployment
リンクのコピー

GET /v1/processes/deployment/{deploymentId}

GetProcessesByDeployment は、指定されたデプロイメントで実行されたプロセスを返します。

54.1.4.1. 説明
リンクのコピー

54.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
deploymentId		X	null

54.1.4.5. レスポンス
リンクのコピー

Expand

表54.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetProcessesResponse
0	予期しないエラーの応答。	GooglerpcStatus

54.1.4.6. Samples
リンクのコピー

第55章 Rbac Service
リンクのコピー

55.1. Rbac Service
リンクのコピー

55.1.1. GetRole
リンクのコピー

GET /v1/rbac/roles/{id}

55.1.1.1. 説明
リンクのコピー

55.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

55.1.1.5. レスポンス
リンクのコピー

Expand

表55.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetRoleResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.1.6. Samples
リンクのコピー

55.1.2. GetRoleBinding
リンクのコピー

GET /v1/rbac/bindings/{id}

55.1.2.1. 説明
リンクのコピー

55.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

55.1.2.5. レスポンス
リンクのコピー

Expand

表55.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetRoleBindingResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.2.6. Samples
リンクのコピー

55.1.3. GetSubject
リンクのコピー

GET /v1/rbac/subject/{id}

この API の対象はグループとユーザーのみです。この場合の ID は Name フィールドです。ユーザーとグループの場合、これは一意であり、サブジェクトには ID がありません。

55.1.3.1. 説明
リンクのコピー

55.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

55.1.3.5. レスポンス
リンクのコピー

Expand

表55.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetSubjectResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.3.6. Samples
リンクのコピー

55.1.4. ListRoleBindings
リンクのコピー

GET /v1/rbac/bindings

55.1.4.1. 説明
リンクのコピー

55.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

55.1.4.5. レスポンス
リンクのコピー

Expand

表55.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListRoleBindingsResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.4.6. Samples
リンクのコピー

55.1.5. ListRoles
リンクのコピー

GET /v1/rbac/roles

55.1.5.1. 説明
リンクのコピー

55.1.5.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

55.1.5.5. レスポンス
リンクのコピー

Expand

表55.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListRolesResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.5.6. Samples
リンクのコピー

55.1.6. ListSubjects
リンクのコピー

GET /v1/rbac/subjects

55.1.6.1. 説明
リンクのコピー

55.1.6.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

55.1.6.5. レスポンス
リンクのコピー

Expand

表55.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListSubjectsResponse
0	予期しないエラーの応答。	GooglerpcStatus

55.1.6.6. Samples
リンクのコピー

第56章 Report Configuration Service
リンクのコピー

56.1. Report Configuration Service
リンクのコピー

56.1.1. CountReportConfigurations
リンクのコピー

GET /v1/report-configurations-count

CountReportConfigurations はレポート設定の数を返します。

56.1.1.1. 説明
リンクのコピー

56.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

56.1.1.5. レスポンス
リンクのコピー

Expand

表56.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountReportConfigurationsResponse
0	予期しないエラーの応答。	GooglerpcStatus

56.1.1.6. Samples
リンクのコピー

56.1.2. DeleteReportConfiguration
リンクのコピー

DELETE /v1/report/configurations/{id}

DeleteReportConfiguration は、id が指定されている場合にレポート設定を削除します。

56.1.2.1. 説明
リンクのコピー

56.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

56.1.2.5. レスポンス
リンクのコピー

Expand

表56.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

56.1.2.6. Samples
リンクのコピー

56.1.3. GetReportConfiguration
リンクのコピー

GET /v1/report/configurations/{id}

56.1.3.1. 説明
リンクのコピー

56.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

56.1.3.5. レスポンス
リンクのコピー

Expand

表56.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetReportConfigurationResponse
0	予期しないエラーの応答。	GooglerpcStatus

56.1.3.6. Samples
リンクのコピー

56.1.4. GetReportConfigurations
リンクのコピー

GET /v1/report/configurations

56.1.4.1. 説明
リンクのコピー

56.1.4.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

56.1.4.5. レスポンス
リンクのコピー

Expand

表56.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetReportConfigurationsResponse
0	予期しないエラーの応答。	GooglerpcStatus

56.1.4.6. Samples
リンクのコピー

56.1.5. PostReportConfiguration
リンクのコピー

POST /v1/report/configurations

PostReportConfiguration はレポート設定を作成します

56.1.5.1. 説明
リンクのコピー

56.1.5.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V1PostReportConfigurationRequest	X

56.1.5.5. レスポンス
リンクのコピー

Expand

表56.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1PostReportConfigurationResponse
0	予期しないエラーの応答。	GooglerpcStatus

56.1.5.6. Samples
リンクのコピー

56.1.6. UpdateReportConfiguration
リンクのコピー

PUT /v1/report/configurations/{id}

UpdateReportConfiguration はレポート設定を更新します

56.1.6.1. 説明
リンクのコピー

56.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

56.1.6.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ReportConfigurationServiceUpdateReportConfigurationBody	X

56.1.6.5. レスポンス
リンクのコピー

Expand

表56.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

56.1.6.6. Samples
リンクのコピー

第57章 Report Service
リンクのコピー

57.1. Report Service
リンクのコピー

57.1.1. CancelReport
リンクのコピー

DELETE /v2/reports/jobs/{id}/cancel

指定されたレポート ID のキューに入れられたレポートジョブをキャンセルします。ジョブがアクティブでない場合は、noop になります。すでにレポートが準備されている場合はキャンセルされません。

57.1.1.1. 説明
リンクのコピー

57.1.1.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.1.5. レスポンス
リンクのコピー

Expand

表57.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

57.1.1.6. Samples
リンクのコピー

57.1.2. CountReportConfigurations
リンクのコピー

GET /v2/reports/configuration-count

CountReportConfigurations はレポート設定の数を返します。

57.1.2.1. 説明
リンクのコピー

57.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

57.1.2.5. レスポンス
リンクのコピー

Expand

表57.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2CountReportConfigurationsResponse
0	予期しないエラーの応答。	RpcStatus

57.1.2.6. Samples
リンクのコピー

57.1.3. DeleteReport
リンクのコピー

DELETE /v2/reports/jobs/{id}/delete

指定されたレポート ID の生成されたレポートを削除します。

57.1.3.1. 説明
リンクのコピー

57.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.3.5. レスポンス
リンクのコピー

Expand

表57.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

57.1.3.6. Samples
リンクのコピー

57.1.4. DeleteReportConfiguration
リンクのコピー

DELETE /v2/reports/configurations/{id}

DeleteReportConfiguration は指定された ID のレポート設定を削除します

57.1.4.1. 説明
リンクのコピー

57.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.4.5. レスポンス
リンクのコピー

Expand

表57.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

57.1.4.6. Samples
リンクのコピー

57.1.5. GetMyReportHistory
リンクのコピー

GET /v2/reports/configurations/{id}/my-history

GetMyReportHistory は、指定された ID を持つレポート設定の要求者のレポートジョブ履歴を返します。

57.1.5.1. 説明
リンクのコピー

57.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.5.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

57.1.5.5. レスポンス
リンクのコピー

Expand

表57.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ReportHistoryResponse
0	予期しないエラーの応答。	RpcStatus

57.1.5.6. Samples
リンクのコピー

57.1.6. GetReportConfiguration
リンクのコピー

GET /v2/reports/configurations/{id}

GetReportConfiguration は指定された ID のレポート設定を返します

57.1.6.1. 説明
リンクのコピー

57.1.6.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.6.5. レスポンス
リンクのコピー

Expand

表57.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ReportConfiguration
0	予期しないエラーの応答。	RpcStatus

57.1.6.6. Samples
リンクのコピー

57.1.7. GetReportHistory
リンクのコピー

GET /v2/reports/configurations/{id}/history

GetReportHistory は、指定された ID を持つレポート設定の完全なレポートジョブ履歴を返します。

57.1.7.1. 説明
リンクのコピー

57.1.7.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.7.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
reportParamQuery.query	-	null
reportParamQuery.pagination.limit	-	null
reportParamQuery.pagination.offset	-	null
reportParamQuery.pagination.sortOption.field	-	null
reportParamQuery.pagination.sortOption.reversed	-	null
reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
reportParamQuery.pagination.sortOption.aggregateBy.distinct	-	null

57.1.7.5. レスポンス
リンクのコピー

Expand

表57.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ReportHistoryResponse
0	予期しないエラーの応答。	RpcStatus

57.1.7.6. Samples
リンクのコピー

57.1.8. GetReportStatus
リンクのコピー

GET /v2/reports/jobs/{id}/status

GetReportStatus は、指定されたレポート ID のレポートステータスを返します

57.1.8.1. 説明
リンクのコピー

57.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.8.5. レスポンス
リンクのコピー

Expand

表57.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ReportStatusResponse
0	予期しないエラーの応答。	RpcStatus

57.1.8.6. Samples
リンクのコピー

57.1.9. ListReportConfigurations
リンクのコピー

GET /v2/reports/configurations

ListReportConfigurations は、指定されたクエリーに一致するレポート設定を返します

57.1.9.1. 説明
リンクのコピー

57.1.9.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

57.1.9.5. レスポンス
リンクのコピー

Expand

表57.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ListReportConfigurationsResponse
0	予期しないエラーの応答。	RpcStatus

57.1.9.6. Samples
リンクのコピー

57.1.10. PostReportConfiguration
リンクのコピー

POST /v2/reports/configurations

PostReportConfiguration はレポート設定を作成します

57.1.10.1. 説明
リンクのコピー

57.1.10.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V2ReportConfiguration	X

57.1.10.5. レスポンス
リンクのコピー

Expand

表57.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2ReportConfiguration
0	予期しないエラーの応答。	RpcStatus

57.1.10.6. Samples
リンクのコピー

57.1.11. RunReport
リンクのコピー

POST /v2/reports/run

このレポートを要求しているユーザーが、同じレポート設定に対して待機中または準備中の別のレポートを持っていない場合は、新しいレポート生成要求を送信します。

57.1.11.1. 説明
リンクのコピー

57.1.11.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	V2RunReportRequest	X

57.1.11.5. レスポンス
リンクのコピー

Expand

表57.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V2RunReportResponse
0	予期しないエラーの応答。	RpcStatus

57.1.11.6. Samples
リンクのコピー

57.1.12. UpdateReportConfiguration
リンクのコピー

PUT /v2/reports/configurations/{id}

UpdateReportConfiguration はレポート設定を更新します

57.1.12.1. 説明
リンクのコピー

57.1.12.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

57.1.12.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	ReportServiceUpdateReportConfigurationBody	X

57.1.12.5. レスポンス
リンクのコピー

Expand

表57.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	RpcStatus

57.1.12.6. Samples
リンクのコピー

第58章 Role Service
リンクのコピー

58.1. Role Service
リンクのコピー

58.1.1. ComputeEffectiveAccessScope
リンクのコピー

POST /v1/computeeffectiveaccessscope

ComputeEffectiveAccessScope

58.1.1.1. 説明
リンクのコピー

リクエスト内のルールに基づいて有効なアクセススコープを返します。永続化されません。クラスターと namespace が変更される可能性があるため、べき等ではありません。ペイロードが大きくなる可能性があるため、POST が選択されます。応答を簡潔かつ詳細に保つことには、どちらにも利点があります。選択されたクラスターおよび namespace の ID のみが含まれる場合、レスポンスのレイテンシーおよび処理時間が短くなりますが、呼び出し元は上記の範囲内でレスポンスをオーバーレイするので、一貫性の問題が発生する可能性があります。関連するメタデータを含むすべてのクラスターと namespace をリスト表示すると、呼び出し元にとっては便利ですが、二次データによりメッセージが肥大化します。呼び出し元が、どのような詳細レベルを希望するかを決定できるようにします。- Minimal: 含まれるサブツリーのルートのみが ID 別にリストされます。クラスターは、INCLUDED (namespace は含まれるがリストされない) または PARTIAL (少なくとも 1 つの namespace が明示的に含まれる) のいずれかになります。namespace は INCLUDED のみ可能です。- Standard [default] では、すべての既知のクラスターと namespace が ID と名前とともにリストされます。クラスターは、INCLUDED (すべての namespace が明示的に INCLUDED としてリストされる)、PARTIAL (すべての namespace が明示的にリストされ、一部は INCLUDED として、一部は EXCLUDED としてリストされる)、および EXCLUDED (すべての namespace が明示的に EXCLUDED としてリストされる) に指定できます。namespace は、INCLUDED または EXCLUDED のいずれかになります。- すべてのクラスターと namespace がメタデータで拡張されている場合は、High になります。

58.1.1.2. パラメーター
リンクのコピー

58.1.1.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
accessScope	ComputeEffectiveAccessScopeRequestPayload	X

58.1.1.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
detail		-	STANDARD

58.1.1.3. 戻り値のタイプ
リンクのコピー

StorageEffectiveAccessScope

58.1.1.4. コンテンツタイプ
リンクのコピー

application/json

58.1.1.5. レスポンス
リンクのコピー

Expand

表58.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageEffectiveAccessScope
0	予期しないエラーの応答。	GooglerpcStatus

58.1.1.6. Samples
リンクのコピー

58.1.2. CreateRole
リンクのコピー

POST /v1/roles/{name}

58.1.2.1. 説明
リンクのコピー

58.1.2.2. パラメーター
リンクのコピー

58.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
name		X	null

58.1.2.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
role	StorageRole	X

58.1.2.3. 戻り値のタイプ
リンクのコピー

Object

58.1.2.4. コンテンツタイプ
リンクのコピー

application/json

58.1.2.5. レスポンス
リンクのコピー

Expand

表58.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.2.6. Samples
リンクのコピー

58.1.3. DeletePermissionSet
リンクのコピー

DELETE /v1/permissionsets/{id}

58.1.3.1. 説明
リンクのコピー

58.1.3.2. パラメーター
リンクのコピー

58.1.3.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.3.3. 戻り値のタイプ
リンクのコピー

Object

58.1.3.4. コンテンツタイプ
リンクのコピー

application/json

58.1.3.5. レスポンス
リンクのコピー

Expand

表58.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.3.6. Samples
リンクのコピー

58.1.4. DeleteRole
リンクのコピー

DELETE /v1/roles/{id}

58.1.4.1. 説明
リンクのコピー

58.1.4.2. パラメーター
リンクのコピー

58.1.4.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.4.3. 戻り値のタイプ
リンクのコピー

Object

58.1.4.4. コンテンツタイプ
リンクのコピー

application/json

58.1.4.5. レスポンス
リンクのコピー

Expand

表58.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.4.6. Samples
リンクのコピー

58.1.5. DeleteSimpleAccessScope
リンクのコピー

DELETE /v1/simpleaccessscopes/{id}

58.1.5.1. 説明
リンクのコピー

58.1.5.2. パラメーター
リンクのコピー

58.1.5.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.5.3. 戻り値のタイプ
リンクのコピー

Object

58.1.5.4. コンテンツタイプ
リンクのコピー

application/json

58.1.5.5. レスポンス
リンクのコピー

Expand

表58.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.5.6. Samples
リンクのコピー

58.1.6. GetClustersForPermissions
リンクのコピー

GET /v1/sac/clusters

GetClustersForPermissions

58.1.6.1. 説明
リンクのコピー

要求された権限のリストに対して、要求ユーザーのスコープによって少なくとも読み取りが許可されているクラスター ID とクラスター名のペアのリストを返します。有効なアクセススコープは、クラスタースコープまたはそれより狭い範囲の入力権限に対してのみ考慮されます (つまり、対象の入力に割り当てられたグローバル権限は無視されます)。入力にグローバルレベルの権限のみが含まれている場合、出力は空のリストになります。入力に権限が指定されていない場合は、クラスタースコープまたはそれより狭い範囲の権限には、要求元のスコープで許可されるすべてのクラスターが応答に含まれます。

58.1.6.2. パラメーター
リンクのコピー

58.1.6.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
permissions	`String`	-	null

58.1.6.3. 戻り値のタイプ
リンクのコピー

V1GetClustersForPermissionsResponse

58.1.6.4. コンテンツタイプ
リンクのコピー

application/json

58.1.6.5. レスポンス
リンクのコピー

Expand

表58.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetClustersForPermissionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.6.6. Samples
リンクのコピー

58.1.7. GetMyPermissions
リンクのコピー

GET /v1/mypermissions

58.1.7.1. 説明
リンクのコピー

58.1.7.2. パラメーター
リンクのコピー

58.1.7.3. 戻り値のタイプ
リンクのコピー

V1GetPermissionsResponse

58.1.7.4. コンテンツタイプ
リンクのコピー

application/json

58.1.7.5. レスポンス
リンクのコピー

Expand

表58.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetPermissionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.7.6. Samples
リンクのコピー

58.1.8. GetNamespacesForClusterAndPermissions
リンクのコピー

GET /v1/sac/clusters/{clusterId}/namespaces

GetNamespacesForClusterAndPermissions

58.1.8.1. 説明
リンクのコピー

要求されたクラスターに属し、namespace スコープまたはそれより範囲が狭い、要求された権限のリストに対してユーザーに少なくとも読み取りアクセス権が付与されている namespace ID と namespace 名のペアのリストを返します (つまり、入力からのグローバル権限とクラスター権限は無視されます)。入力にグローバルレベルまたはクラスターレベルの権限のみが含まれている場合、出力は空のリストになります。入力に権限が指定されていない場合は、namespace スコープまたはそれより狭い範囲の権限には、要求元のスコープで許可されるすべての namespace が応答に含まれます。

58.1.8.2. パラメーター
リンクのコピー

58.1.8.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
clusterId		X	null

58.1.8.2.2. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
permissions	`String`	-	null

58.1.8.3. 戻り値のタイプ
リンクのコピー

V1GetNamespacesForClusterAndPermissionsResponse

58.1.8.4. コンテンツタイプ
リンクのコピー

application/json

58.1.8.5. レスポンス
リンクのコピー

Expand

表58.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetNamespacesForClusterAndPermissionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.8.6. Samples
リンクのコピー

58.1.9. GetPermissionSet
リンクのコピー

GET /v1/permissionsets/{id}

58.1.9.1. 説明
リンクのコピー

58.1.9.2. パラメーター
リンクのコピー

58.1.9.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.9.3. 戻り値のタイプ
リンクのコピー

StoragePermissionSet

58.1.9.4. コンテンツタイプ
リンクのコピー

application/json

58.1.9.5. レスポンス
リンクのコピー

Expand

表58.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePermissionSet
0	予期しないエラーの応答。	GooglerpcStatus

58.1.9.6. Samples
リンクのコピー

58.1.10. GetResources
リンクのコピー

GET /v1/resources

58.1.10.1. 説明
リンクのコピー

58.1.10.2. パラメーター
リンクのコピー

58.1.10.3. 戻り値のタイプ
リンクのコピー

V1GetResourcesResponse

58.1.10.4. コンテンツタイプ
リンクのコピー

application/json

58.1.10.5. レスポンス
リンクのコピー

Expand

表58.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetResourcesResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.10.6. Samples
リンクのコピー

58.1.11. GetRole
リンクのコピー

GET /v1/roles/{id}

58.1.11.1. 説明
リンクのコピー

58.1.11.2. パラメーター
リンクのコピー

58.1.11.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.11.3. 戻り値のタイプ
リンクのコピー

StorageRole

58.1.11.4. コンテンツタイプ
リンクのコピー

application/json

58.1.11.5. レスポンス
リンクのコピー

Expand

表58.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageRole
0	予期しないエラーの応答。	GooglerpcStatus

58.1.11.6. Samples
リンクのコピー

58.1.12. GetRoles
リンクのコピー

GET /v1/roles

58.1.12.1. 説明
リンクのコピー

58.1.12.2. パラメーター
リンクのコピー

58.1.12.3. 戻り値のタイプ
リンクのコピー

V1GetRolesResponse

58.1.12.4. コンテンツタイプ
リンクのコピー

application/json

58.1.12.5. レスポンス
リンクのコピー

Expand

表58.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetRolesResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.12.6. Samples
リンクのコピー

58.1.13. GetSimpleAccessScope
リンクのコピー

GET /v1/simpleaccessscopes/{id}

58.1.13.1. 説明
リンクのコピー

58.1.13.2. パラメーター
リンクのコピー

58.1.13.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

58.1.13.3. 戻り値のタイプ
リンクのコピー

StorageSimpleAccessScope

58.1.13.4. コンテンツタイプ
リンクのコピー

application/json

58.1.13.5. レスポンス
リンクのコピー

Expand

表58.13 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageSimpleAccessScope
0	予期しないエラーの応答。	GooglerpcStatus

58.1.13.6. Samples
リンクのコピー

58.1.14. ListPermissionSets
リンクのコピー

GET /v1/permissionsets

58.1.14.1. 説明
リンクのコピー

58.1.14.2. パラメーター
リンクのコピー

58.1.14.3. 戻り値のタイプ
リンクのコピー

V1ListPermissionSetsResponse

58.1.14.4. コンテンツタイプ
リンクのコピー

application/json

58.1.14.5. レスポンス
リンクのコピー

Expand

表58.14 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListPermissionSetsResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.14.6. Samples
リンクのコピー

58.1.15. ListSimpleAccessScopes
リンクのコピー

GET /v1/simpleaccessscopes

58.1.15.1. 説明
リンクのコピー

58.1.15.2. パラメーター
リンクのコピー

58.1.15.3. 戻り値のタイプ
リンクのコピー

V1ListSimpleAccessScopesResponse

58.1.15.4. コンテンツタイプ
リンクのコピー

application/json

58.1.15.5. レスポンス
リンクのコピー

Expand

表58.15 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListSimpleAccessScopesResponse
0	予期しないエラーの応答。	GooglerpcStatus

58.1.15.6. Samples
リンクのコピー

58.1.16. PostPermissionSet
リンクのコピー

POST /v1/permissionsets

PostPermissionSet

58.1.16.1. 説明
リンクのコピー

PermissionSet.id はリクエストでは許可されず、レスポンスで設定されます。

58.1.16.2. パラメーター
リンクのコピー

58.1.16.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	これは、StackRox リソースの権限セットをエンコードします。StoragePermissionSet	X

58.1.16.3. 戻り値のタイプ
リンクのコピー

StoragePermissionSet

58.1.16.4. コンテンツタイプ
リンクのコピー

application/json

58.1.16.5. レスポンス
リンクのコピー

Expand

表58.16 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StoragePermissionSet
0	予期しないエラーの応答。	GooglerpcStatus

58.1.16.6. Samples
リンクのコピー

58.1.17. PostSimpleAccessScope
リンクのコピー

POST /v1/simpleaccessscopes

PostSimpleAccessScope

58.1.17.1. 説明
リンクのコピー

SimpleAccessScope.id はリクエストでは許可されず、レスポンスで設定されます。

58.1.17.2. パラメーター
リンクのコピー

58.1.17.2.1. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	シンプルアクセススコープは、スコープ指定されたリソースの (シンプルな) 選択基準です。複数コンポーネントの AND ルールや名前に対するセット操作は許可されません。StorageSimpleAccessScope	X

58.1.17.3. 戻り値のタイプ
リンクのコピー

StorageSimpleAccessScope

58.1.17.4. コンテンツタイプ
リンクのコピー

application/json

58.1.17.5. レスポンス
リンクのコピー

Expand

表58.17 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageSimpleAccessScope
0	予期しないエラーの応答。	GooglerpcStatus

58.1.17.6. Samples
リンクのコピー

58.1.18. PutPermissionSet
リンクのコピー

PUT /v1/permissionsets/{id}

58.1.18.1. 説明
リンクのコピー

58.1.18.2. パラメーター
リンクのコピー

58.1.18.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id	id は自動で入力されるため、変更できません。	X	null

58.1.18.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	RoleServicePutPermissionSetBody	X

58.1.18.3. 戻り値のタイプ
リンクのコピー

Object

58.1.18.4. コンテンツタイプ
リンクのコピー

application/json

58.1.18.5. レスポンス
リンクのコピー

Expand

表58.18 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.18.6. Samples
リンクのコピー

58.1.19. PutSimpleAccessScope
リンクのコピー

PUT /v1/simpleaccessscopes/{id}

58.1.19.1. 説明
リンクのコピー

58.1.19.2. パラメーター
リンクのコピー

58.1.19.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id	`id` は自動で入力されるため、変更できません。	X	null

58.1.19.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	RoleServicePutSimpleAccessScopeBody	X

58.1.19.3. 戻り値のタイプ
リンクのコピー

Object

58.1.19.4. コンテンツタイプ
リンクのコピー

application/json

58.1.19.5. レスポンス
リンクのコピー

Expand

表58.19 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.19.6. Samples
リンクのコピー

58.1.20. UpdateRole
リンクのコピー

PUT /v1/roles/{name}

58.1.20.1. 説明
リンクのコピー

58.1.20.2. パラメーター
リンクのコピー

58.1.20.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
name	`name` と `description` はユーザーが指定して変更できます。	X	null

58.1.20.2.2. 本文パラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
body	RoleServiceUpdateRoleBody	X

58.1.20.3. 戻り値のタイプ
リンクのコピー

Object

58.1.20.4. コンテンツタイプ
リンクのコピー

application/json

58.1.20.5. レスポンス
リンクのコピー

Expand

表58.20 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

58.1.20.6. Samples
リンクのコピー

第59章 Search Service
リンクのコピー

59.1. Search Service
リンクのコピー

59.1.1. Autocomplete
リンクのコピー

GET /v1/search/autocomplete

59.1.1.1. 説明
リンクのコピー

59.1.1.2. パラメーター
リンクのコピー

59.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
query		-	null
categories	`String`	-	null

59.1.1.3. 戻り値のタイプ
リンクのコピー

V1AutocompleteResponse

59.1.1.4. コンテンツタイプ
リンクのコピー

application/json

59.1.1.5. レスポンス
リンクのコピー

Expand

表59.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AutocompleteResponse
0	予期しないエラーの応答。	GooglerpcStatus

59.1.1.6. Samples
リンクのコピー

59.1.2. オプション
リンクのコピー

GET /v1/search/metadata/options

59.1.2.1. 説明
リンクのコピー

59.1.2.2. パラメーター
リンクのコピー

59.1.2.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
categories	`String`	-	null

59.1.2.3. 戻り値のタイプ
リンクのコピー

V1SearchOptionsResponse

59.1.2.4. コンテンツタイプ
リンクのコピー

application/json

59.1.2.5. レスポンス
リンクのコピー

Expand

表59.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1SearchOptionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

59.1.2.6. Samples
リンクのコピー

59.1.3. 検索
リンクのコピー

GET /v1/search

59.1.3.1. 説明
リンクのコピー

59.1.3.2. パラメーター
リンクのコピー

59.1.3.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
query		-	null
categories	`String`	-	null

59.1.3.3. 戻り値のタイプ
リンクのコピー

V1SearchResponse

59.1.3.4. コンテンツタイプ
リンクのコピー

application/json

59.1.3.5. レスポンス
リンクのコピー

Expand

表59.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1SearchResponse
0	予期しないエラーの応答。	GooglerpcStatus

59.1.3.6. Samples
リンクのコピー

第60章 Secret Service
リンクのコピー

60.1. Secret Service
リンクのコピー

60.1.1. CountSecrets
リンクのコピー

GET /v1/secretscount

CountSecrets はシークレットの数を返します。

60.1.1.1. 説明
リンクのコピー

60.1.1.2. パラメーター
リンクのコピー

60.1.1.2.1. クエリーパラメーター
リンクのコピー

Expand

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

60.1.1.3. 戻り値のタイプ
リンクのコピー

V1CountSecretsResponse

60.1.1.4. コンテンツタイプ
リンクのコピー

application/json

60.1.1.5. レスポンス
リンクのコピー

Expand

表60.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountSecretsResponse
0	予期しないエラーの応答。	GooglerpcStatus

60.1.1.6. Samples
リンクのコピー

60.1.2. GetSecret
リンクのコピー

GET /v1/secrets/{id}

GetSecret は、ID が指定されている場合にシークレットを返します。

60.1.2.1. 説明
リンクのコピー

60.1.2.2. パラメーター
リンクのコピー

60.1.2.2.1. パスパラメーター
リンクのコピー

Expand

名前	説明	必須	デフォルト	パターン
id		X	null

60.1.2.3. 戻り値のタイプ
リンクのコピー

StorageSecret

60.1.2.4. コンテンツタイプ
リンクのコピー

application/json

60.1.2.5. レスポンス
リンクのコピー

Expand

表60.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageSecret
0	予期しないエラーの応答。	GooglerpcStatus

Red Hat Advanced Cluster Security for Kubernetes の API リファレンスガイド

第1章 Administration Event Serviceリンクのコピーリンクがクリップボードにコピーされました!

1.1. Administration Event Serviceリンクのコピーリンクがクリップボードにコピーされました!

1.1.1. CountAdministrationEventsリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

1.1.1.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

1.1.1.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

1.1.2. GetAdministrationEventリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

1.1.2.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.2.1. パスパラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

1.1.2.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

1.1.3. ListAdministrationEventsリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

1.1.3.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

1.1.3.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

第2章 Administration Usage Serviceリンクのコピーリンクがクリップボードにコピーされました!

2.1. Administration Usage Serviceリンクのコピーリンクがクリップボードにコピーされました!

2.1.1. GetCurrentSecuredUnitsUsageリンクのコピーリンクがクリップボードにコピーされました!

2.1.1.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

2.1.1.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

2.1.1.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

2.1.1.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

2.1.1.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

2.1.1.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

2.1.2. GetMaxSecuredUnitsUsageリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

2.1.2.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

2.1.2.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

第3章 Alert Serviceリンクのコピーリンクがクリップボードにコピーされました!

3.1. Alert Serviceリンクのコピーリンクがクリップボードにコピーされました!

3.1.1. CountAlertsリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

3.1.1.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

3.1.1.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

3.1.2. DeleteAlertsリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

3.1.2.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

3.1.2.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

3.1.3. GetAlertリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

3.1.3.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.2.1. パスパラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

3.1.3.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

3.1.4. GetAlertTimeseriesリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.1. 説明リンクのコピーリンクがクリップボードにコピーされました!

3.1.4.2. パラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.2.1. クエリーパラメーターリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.3. 戻り値のタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.4. コンテンツタイプリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.5. レスポンスリンクのコピーリンクがクリップボードにコピーされました!

3.1.4.6. Samplesリンクのコピーリンクがクリップボードにコピーされました!

3.1.5. GetAlertsCountsリンクのコピーリンクがクリップボードにコピーされました!

第1章 Administration Event Service
リンクのコピー

1.1. Administration Event Service
リンクのコピー

1.1.1. CountAdministrationEvents
リンクのコピー

1.1.1.1. 説明
リンクのコピー

1.1.1.2. パラメーター
リンクのコピー

1.1.1.2.1. クエリーパラメーター
リンクのコピー

1.1.1.3. 戻り値のタイプ
リンクのコピー

1.1.1.4. コンテンツタイプ
リンクのコピー

1.1.1.5. レスポンス
リンクのコピー

1.1.1.6. Samples
リンクのコピー

1.1.2. GetAdministrationEvent
リンクのコピー

1.1.2.1. 説明
リンクのコピー

1.1.2.2. パラメーター
リンクのコピー

1.1.2.2.1. パスパラメーター
リンクのコピー

1.1.2.3. 戻り値のタイプ
リンクのコピー

1.1.2.4. コンテンツタイプ
リンクのコピー

1.1.2.5. レスポンス
リンクのコピー

1.1.2.6. Samples
リンクのコピー

1.1.3. ListAdministrationEvents
リンクのコピー

1.1.3.1. 説明
リンクのコピー

1.1.3.2. パラメーター
リンクのコピー

1.1.3.2.1. クエリーパラメーター
リンクのコピー

1.1.3.3. 戻り値のタイプ
リンクのコピー

1.1.3.4. コンテンツタイプ
リンクのコピー

1.1.3.5. レスポンス
リンクのコピー

1.1.3.6. Samples
リンクのコピー

第2章 Administration Usage Service
リンクのコピー

2.1. Administration Usage Service
リンクのコピー

2.1.1. GetCurrentSecuredUnitsUsage
リンクのコピー

2.1.1.1. 説明
リンクのコピー

2.1.1.2. パラメーター
リンクのコピー

2.1.1.3. 戻り値のタイプ
リンクのコピー

2.1.1.4. コンテンツタイプ
リンクのコピー

2.1.1.5. レスポンス
リンクのコピー

2.1.1.6. Samples
リンクのコピー

2.1.2. GetMaxSecuredUnitsUsage
リンクのコピー

2.1.2.1. 説明
リンクのコピー

2.1.2.2. パラメーター
リンクのコピー

2.1.2.2.1. クエリーパラメーター
リンクのコピー

2.1.2.3. 戻り値のタイプ
リンクのコピー

2.1.2.4. コンテンツタイプ
リンクのコピー

2.1.2.5. レスポンス
リンクのコピー

2.1.2.6. Samples
リンクのコピー

第3章 Alert Service
リンクのコピー

3.1. Alert Service
リンクのコピー

3.1.1. CountAlerts
リンクのコピー

3.1.1.1. 説明
リンクのコピー

3.1.1.2. パラメーター
リンクのコピー

3.1.1.2.1. クエリーパラメーター
リンクのコピー

3.1.1.3. 戻り値のタイプ
リンクのコピー

3.1.1.4. コンテンツタイプ
リンクのコピー

3.1.1.5. レスポンス
リンクのコピー

3.1.1.6. Samples
リンクのコピー

3.1.2. DeleteAlerts
リンクのコピー

3.1.2.1. 説明
リンクのコピー

3.1.2.2. パラメーター
リンクのコピー

3.1.2.2.1. クエリーパラメーター
リンクのコピー

3.1.2.3. 戻り値のタイプ
リンクのコピー

3.1.2.4. コンテンツタイプ
リンクのコピー

3.1.2.5. レスポンス
リンクのコピー

3.1.2.6. Samples
リンクのコピー

3.1.3. GetAlert
リンクのコピー

3.1.3.1. 説明
リンクのコピー

3.1.3.2. パラメーター
リンクのコピー

3.1.3.2.1. パスパラメーター
リンクのコピー

3.1.3.3. 戻り値のタイプ
リンクのコピー

3.1.3.4. コンテンツタイプ
リンクのコピー

3.1.3.5. レスポンス
リンクのコピー

3.1.3.6. Samples
リンクのコピー

3.1.4. GetAlertTimeseries
リンクのコピー

3.1.4.1. 説明
リンクのコピー

3.1.4.2. パラメーター
リンクのコピー

3.1.4.2.1. クエリーパラメーター
リンクのコピー

3.1.4.3. 戻り値のタイプ
リンクのコピー

3.1.4.4. コンテンツタイプ
リンクのコピー

3.1.4.5. レスポンス
リンクのコピー

3.1.4.6. Samples
リンクのコピー

3.1.5. GetAlertsCounts
リンクのコピー

3.1.5.1. 説明
リンクのコピー

3.1.5.2. パラメーター
リンクのコピー