Method: projects.locations.backupPlans.list

Lista os BackupPlans em um determinado local.

Solicitação HTTP

GET https://gkebackup.googleapis.com/v1/{parent=projects/*/locations/*}/backupPlans

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O local que contém os BackupPlans a serem listados. Formato: projects/*/locations/*

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • gkebackup.backupPlans.list

Parâmetros de consulta

Parâmetros
pageSize

integer

O número pretendido de resultados a serem retornados em uma única resposta. Se não for especificado, um valor padrão será escolhido pelo serviço. A resposta pode incluir uma lista parcial. O autor da chamada precisa confiar apenas no nextPageToken da resposta para determinar se há mais instâncias a serem consultadas.
pageToken

string

O valor de nextPageToken recebido de uma chamada anterior de backupPlans.list. Forneça isso para recuperar a página seguinte em uma lista de resultados com várias páginas. Ao paginar, todos os outros parâmetros fornecidos para backupPlans.list precisam corresponder à chamada que forneceu o token da página.
filter

string

Expressão de correspondência de campo usada para filtrar os resultados.
orderBy

string

Campo pelo qual ordenar os resultados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para backupPlans.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "backupPlans": [
    {
      object (BackupPlan)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
backupPlans[]

object (BackupPlan)

A lista de BackupPlans que corresponde aos critérios fornecidos.
nextPageToken

string

Um token que pode ser enviado como pageToken em uma chamada backupPlans.list subsequente para recuperar a próxima página de resultados. Se o campo for omitido ou estiver vazio, não haverá mais resultados para retornar.
unreachable[]

string

Locais que não puderam ser alcançados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.