Método: keyRings.list

Nombre completo: projects.locations.keyRings.list

Permite mostrar una lista de KeyRings.

Solicitud HTTP

GET https://cloudkms.googleapis.com/v1/{parent=projects/*/locations/*}/keyRings

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El nombre de recurso de la ubicación asociada con los KeyRings, en el formato projects/*/locations/*.

La autorización necesita el siguiente permiso de Google IAM sobre el parent del recurso especificado:

  • cloudkms.keyRings.list

Parámetros de búsqueda

Parámetros
pageSize

number

Límite opcional de la cantidad de KeyRings que se deben incluir en la respuesta. Además, se pueden obtener KeyRings adicionales si se incluye el ListKeyRingsResponse.next_page_token en una solicitud posterior. El servidor elegirá un valor predeterminado adecuado si es que no se proporciona uno

pageToken

string

Token de paginación opcional, que se mostró anteriormente con ListKeyRingsResponse.next_page_token

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

Mensaje de respuesta para KeyManagementService.ListKeyRings.

Representación JSON

{
  "keyRings": [
    {
      object(KeyRing)
    }
  ],
  "nextPageToken": string,
  "totalSize": number
}
Campos
keyRings[]

object(KeyRing)

La lista de KeyRings.

nextPageToken

string

Un token para recuperar la siguiente página de resultados. Pasa este valor en ListKeyRingsRequest.page_token para recuperar la siguiente página de resultados.

totalSize

number

La cantidad total de KeyRings que coincidieron con la consulta.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

Pruébalo

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Documentación de Cloud KMS