Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

3.3. ListAlerts

GET /v1/alerts

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

3.3.1. 説明
リンクのコピー

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

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

Expand
名前説明必須デフォルトPattern

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.3.3. 戻り値のタイプ
リンクのコピー

V1ListAlertsResponse

3.3.4. コンテンツタイプ
リンクのコピー

  • application/json

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

Expand
表3.3 HTTP 応答コード
コードメッセージデータタイプ

200

正常な応答。

V1ListAlertsResponse

0

予期しないエラーの応答です。

RuntimeError

3.3.6. サンプル
リンクのコピー

3.3.7. 共通のオブジェクト参照
リンクのコピー

3.3.7.1. ListAlertCommonEntityInfo
リンクのコピー

アラートが属する可能性のあるすべてのエンティティーに共通するフィールド。

Expand
フィールド名必須Null 許容型型説明形式

clusterName

  

String

  

namespace

  

String

  

clusterId

  

String

  

namespaceId

  

String

  

resourceType

  

StorageListAlertResourceType

 

DEPLOYMENT、SECRETS、CONFIGMAP、CLUSTER_ROLES、CLUSTER_ROLE_BINDINGS、NETWORK_POLICIES、SECURITY_CONTEXT_CONSTRAINTS、EGRESS_FIREWALLS、

3.3.7.2. ListAlertPolicyDevFields
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

SORTName

  

String

  

3.3.7.3. ListAlertResourceEntity
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

name

  

String

  

3.3.7.4. ProtobufAny
リンクのコピー

any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。

例 1: C++ のメッセージをパックして展開します。 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

例 2: Java でメッセージをパックして解凍します。 

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
Copy to Clipboard Toggle word wrap 
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap 
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

protobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。

3.3.7.4.1. JSON 表現
リンクのコピー

Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例（メッセージ [google.protobuf.Duration][] の場合）: 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型型説明形式

typeUrl

  

String

シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( path/google.protobuf.Durationにあるように)を表す必要があります。名前は正規の形式である必要があります（たとえば、先頭 \".\" は受け入れられません）。実際には、チームは通常、バイナリーにプリコンパイルして、任意 のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム http、https、またはスキームを使用しない URL の場合、以下のようにタイプ URL をメッセージ定義にマップするタイプサーバーを設定できます。* スキームが指定されていない場合、https は想定されます。* URL の HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成するか、エラーを生成する必要があります。* アプリケーションは、URL に基づいてルックアップ結果をキャッシュするか、ルックアップを回避するためにバイナリーにプリコンパイルして使用できます。したがって、タイプへの変更時にバイナリー互換性を保持する必要があります。（バージョン付けされたタイプ名を使用して、重大な変更を管理します。）注記：この機能は現在、公式の protobuf リリースでは利用できないため、type.googleapis.com で始まるタイプ URL には使用されません。2023 年 5 月時点では、広く使用されているタイプサーバー実装はもう 1 つも実装する予定はありません。http 以外のスキーム、https （または空のスキーム）は、実装固有のセマンティクスで使用できます。

 

value

  

byte[]

上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。

byte

3.3.7.5. RuntimeError
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

3.3.7.6. StorageEnforcementAction
リンクのコピー

  • FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT は、アドミッションコントロール Webhook が実行およびポート転送イベントをリッスンするように有効にされている場合にのみ有効になります。
  • FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT は、オブジェクト作成を強制するように受付コントロール Webhook が設定されている場合にのみ有効です。
  • FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT は、オブジェクトの更新を強制するように受付コントロール Webhook が設定されている場合にのみ有効になります。
Expand
Enum 値

UNSET_ENFORCEMENT

SCALE_TO_ZERO_ENFORCEMENT

UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT

KILL_POD_ENFORCEMENT

FAIL_BUILD_ENFORCEMENT

FAIL_KUBE_REQUEST_ENFORCEMENT

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT

FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

3.3.7.7. StorageLifecycleStage
リンクのコピー

Expand
Enum 値

DEPLOY

BUILD

RUNTIME （ランタイム）

3.3.7.8. StorageListAlert
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

id

  

String

  

lifecycleStage

  

StorageLifecycleStage

 

DEPLOY、BUILD、RUNTIME

time

  

Date

 

date-time

policy

  

StorageListAlertPolicy

  

state

  

StorageViolationState

 

ACTIVE、SNOOZED、解決済み、試行済み

enforcementCount

  

Integer

 

int32

enforcementAction

  

StorageEnforcementAction

 

UNSET_ENFORCEMENT、SCALE_TO_ZERO_ENFORCEMENT、UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT、KILL_POD_ENFORCEMENT、FAIL_BUILD_ENFORCEMENT、FAIL_KUBE_REQUEST_ENFORCEMENT、FAIL_DEPLOYMENT_CREATE_ENFORCEMENT、FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT、FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,

commonEntityInfo

  

ListAlertCommonEntityInfo

  

deployment

  

StorageListAlertDeployment

  

resource

  

ListAlertResourceEntity

  

3.3.7.9. StorageListAlertDeployment
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

id

  

String

  

name

  

String

  

clusterName

  

String

このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。

 

namespace

  

String

このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。

 

clusterId

  

String

このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。

 

inactive

  

Boolean

  

namespaceId

  

String

このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。

 

3.3.7.10. StorageListAlertPolicy
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

id

  

String

  

name

  

String

  

severity

  

StorageSeverity

 

UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、

description

  

String

  

categories

  

string のリスト

  

developerInternalFields

  

ListAlertPolicyDevFields

  

3.3.7.11. StorageListAlertResourceType
リンクのコピー

A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)
Copy to Clipboard Toggle word wrap
Expand
Enum 値

DEPLOYMENT

SECRETS

CONFIGMAPS

CLUSTER_ROLES

CLUSTER_ROLE_BINDINGS

NETWORK_POLICIES

SECURITY_CONTEXT_CONSTRAINTS

EGRESS_FIREWALLS

3.3.7.12. StorageSeverity
リンクのコピー

Expand
Enum 値

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

3.3.7.13. StorageViolationState
リンクのコピー

Expand
Enum 値

ACTIVE

SNOOZED

RESOLVED

ATTEMPTED

3.3.7.14. V1ListAlertsResponse
リンクのコピー

Expand
フィールド名必須Null 許容型型説明形式

alerts

  

StorageListAlertのリスト

  
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat