Method: projects.locations.backupPlans.list

Muestra una lista de BackupPlans en una ubicación determinada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. La ubicación que contiene los BackupPlans que se van a enumerar. Formato: projects/*/locations/*

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • gkebackup.backupPlans.list

Parámetros de consulta

Parámetros
pageSize

integer

La cantidad objetivo de resultados que se mostrarán en una sola respuesta. Si no se especifica, el servicio elegirá un valor predeterminado. Ten en cuenta que la respuesta puede incluir una lista parcial y el emisor solo debe confiar en el nextPageToken de la respuesta para determinar si quedan más instancias para consultar.
pageToken

string

El valor de nextPageToken recibido de una llamada backupPlans.list anterior. Proporciona esto para recuperar la página siguiente en una lista de resultados de varias páginas. Cuando ocurre la paginación, todos los demás parámetros proporcionados a backupPlans.list deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Expresión de coincidencia de campo que se usa para filtrar los resultados.
orderBy

string

Campo según el cual se ordenan los resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para backupPlans.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "backupPlans": [
    {
      object (BackupPlan)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
backupPlans[]

object (BackupPlan)

La lista de BackupPlans que coinciden con los criterios especificados.
nextPageToken

string

Un token que se puede enviar como pageToken en una llamada backupPlans.list posterior para recuperar la siguiente página de resultados. Si este campo se omite o está vacío, no hay más resultados para mostrar.
unreachable[]

string

Ubicaciones en las que no se pudo acceder.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.