第54章 SecretService


54.1. CountSecrets

GET /v1/secretscount

CountSecrets はシークレットの数を返します。

54.1.1. 説明

54.1.2. パラメーター

54.1.2.1. クエリーパラメーター

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

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.3. 戻り値のタイプ

V1CountSecretsResponse

54.1.4. コンテンツタイプ

  • application/json

54.1.5. レスポンス

表54.1 HTTP レスポンスコード
コードメッセージデータ型

200

正常な応答。

V1CountSecretsResponse

0

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

GooglerpcStatus

54.1.6. サンプル

54.1.7. 共通のオブジェクト参照

54.1.7.1. GooglerpcStatus

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

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAny のリスト

  

54.1.7.2. ProtobufAny

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

Protobuf ライブラリーは、ユーティリティー関数または Any 型の追加の生成メソッドといった形式で Any 値をパック/アンパックするためのサポートを提供します。

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

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 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());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

protobuf ライブラリーによって提供される pack メソッドは、デフォルトで型 URL として 'type.googleapis.com/full.type.name' を使用し、unpack メソッドは型 URL の最後の '/' の後の完全修飾型名のみを使用します。たとえば、"foo.bar.com/x/y.z" は型名 "y.z" を生成します。

54.1.7.2.1. JSON 表現

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

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

埋め込まれたメッセージ型が一般的であり、カスタム JSON 表現がある場合、その表現には、@type フィールドに加えてカスタム JSON を保持するフィールドの が追加されて埋め込まれます。例 ([google.protobuf.Duration][] メッセージの場合):

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

@type

  

String

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

 

54.1.7.3. V1CountSecretsResponse

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

count

  

Integer

 

int32

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.