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

指定したロケーション（リージョン）またはすべてのロケーションのいずれかのプロジェクトによって所有されているすべての Redis インスタンスをリストします。

ロケーションは次の形式で指定する必要があります: * projects/{projectId}/locations/{locationId}

locationId として -（ワイルドカード）を指定すると、そのプロジェクトで使用可能なすべてのリージョンがクエリの対象となり、結果が集約されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

クエリ パラメータ

パラメータ
pageSize

number

返すアイテムの最大数。

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

string

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

リクエストの本文

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

レスポンスの本文

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

instances.list のレスポンス。

JSON 表現 

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

object（Instance）

指定したロケーション、または全ロケーションのプロジェクト内の Redis インスタンスのリスト。

リクエストの parent フィールドの locationId が「-」の場合、そのプロジェクトで使用可能なすべてのリージョンがクエリの対象となり、結果が集約されます。そのような集約されたクエリでロケーションを使用できない場合、レスポンスにはダミーの Redis エントリが含まれ、「name」フィールドは projects/{projectId}/locations/{locationId}/instances/- という形式の値に設定されます。また、「status」フィールドは ERROR に設定され、「statusMessage」フィールドは「location not available for instances.list」に設定されます。
nextPageToken

string

結果の次のページを取得するためのトークン。または、それ以上の結果がない場合は空です。

unreachable[]

string

到達できなかった場所。

承認スコープ

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

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

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