Method: projects.locations.instances.list

指定されたプロジェクトとロケーションでのインスタンスを一覧表示します。

HTTP リクエスト


GET https://memorystore.googleapis.com/v1/{parent=projects/*/locations/*}/instances

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。インスタンスを一覧表示する親。形式: projects/{project}/locations/{location}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークン。
filter

string

省略可。結果をフィルタリングする式。
orderBy

string

省略可。定義された順序で結果を並べ替えます。サポートされている値: 「name」、「createTime」。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

instances.list に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "instances": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
instances[]

object (Instance)

リクエストされた {location} が「-」の場合、レスポンスにはすべてのロケーションのインスタンスのリストが含まれます。到達できないロケーションにあるインスタンスは除外されます。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
unreachable[]

string

到達できなかったロケーション。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/memorystore.read-write
  • https://www.googleapis.com/auth/memorystore.read-only

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • memorystore.instances.list

詳細については、IAM のドキュメントをご覧ください。