Method: projects.locations.clusters.list

지정된 위치 (리전) 또는 모든 위치에 있는 프로젝트 소유의 모든 Redis 클러스터를 나열합니다.

위치는 다음과 같은 형식이어야 합니다.

  • projects/{projectId}/locations/{locationId}

locationId이 - (와일드카드)로 지정되면 프로젝트에 사용 가능한 모든 리전이 쿼리되고 결과가 집계됩니다.

HTTP 요청

GET https://redis.googleapis.com/v1beta1/{parent=projects/*/locations/*}/clusters

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 입력란입니다. projects/{projectId}/locations/{locationId} 형식을 사용하는 클러스터 위치의 리소스 이름입니다. 여기서 locationId는 Google Cloud 리전을 나타냅니다.

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 항목 수입니다.

지정하지 않으면 서비스는 기본값인 1,000을 사용합니다. pageSize 값에 관계없이 응답에는 부분 목록이 포함될 수 있으며 호출자는 응답의 nextPageToken만 사용하여 쿼리할 클러스터가 더 남아 있는지 확인해야 합니다.
pageToken

string

이전 [clusters.list][CloudRedis.ListClusters] 요청에서 반환된 nextPageToken 값입니다(있는 경우).

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

[clusters.list][CloudRedis.ListClusters]에 대한 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
필드
clusters[]

object (Cluster)

지정된 위치 또는 모든 위치에 걸쳐 있는 프로젝트의 Redis 클러스터 목록입니다.

요청의 상위 필드에 있는 locationId가 '-'이면 프로젝트에 사용 가능한 모든 리전이 쿼리되고 결과가 집계됩니다. 이러한 집계된 쿼리에서 위치를 사용할 수 없는 경우 자리표시자 Redis 항목이 응답에 포함되며 name 필드는 projects/{projectId}/locations/{locationId}/clusters/- 형식의 값으로 설정되고 status 필드는 ERROR로 설정되고 statusMessage 필드는 'location not available for clusters.list'로 설정됩니다.
nextPageToken

string

결과의 다음 페이지를 검색하는 토큰이거나 목록에 더 이상 결과가 없으면 비어 있습니다.
unreachable[]

string

도달할 수 없는 위치입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 Authentication Overview를 참조하세요.