メソッド: projects.locations.instances.list

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

HTTP リクエスト

GET https://memcache.googleapis.com/v1beta2/{parent=projects/*/locations/*}/instances

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

パスパラメータ

パラメータ
parent

string

必須。projects/{project_id}/locations/{locationId} という形式を使用したインスタンス・ロケーションのリソース名。locationId は GCP リージョンを表します。

クエリ パラメータ

パラメータ
pageSize

integer

返すアイテムの最大数。

指定しない場合は、デフォルト値の 1000 が使用されます。pageSize 値に関係なく、レスポンスには部分的なリストが含まれる場合があり、クエリ対象のインスタンスが他にも存在するかどうかを見極めるため、呼び出し元はレスポンスの [nextPageToken][CloudMemcache.ListInstancesResponse.next_page_token] のみを信頼します。
pageToken

string

前の List リクエストから返された nextPageToken 値（存在する場合）。
filter

string

リストフィルタ。たとえば、「name != my-instance」を指定して、「my-instance」という名前の Memcached インスタンスをすべて除外します。
orderBy

string

結果の並べ替え。サポートされている値は「name」、「name desc」、または「」（並べ替えなし）です。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

instances.list に対するレスポンス。

JSON 表現 

{
  "resources": [
    {
      object (Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
項目
resources[]

object (Instance)

指定されたロケーション、またはすべてのロケーションにあるプロジェクト内の Memcached インスタンスのリスト。

リクエストの parent フィールドの locationId が「-」の場合、プロジェクトで使用可能なすべてのリージョンがクエリ対象となり、結果が集計されます。
nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。
unreachable[]

string

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。