Method: projects.locations.announcements.list

Liste les Announcements pour une région et un projet donnés.

Requête HTTP

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*}/announcements

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'établissement pour lequel interroger les annonces. Les noms de ressources sont des URI sans schéma qui suivent les conventions décrites sur https://cloud.google.com/apis/design/resource_names. Par exemple : projects/my-project/locations/us-west1-a

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • vmwareengine.announcements.list

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal d'annonces à renvoyer sur une page. Le service peut renvoyer un nombre inférieur à cette valeur. La valeur maximale est ramenée à 1 000. La valeur par défaut de ce champ est 500.
pageToken

string

Jeton de page reçu d'un appel announcements.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à announcements.list doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Expression de filtre qui correspond aux ressources renvoyées dans la réponse. L'expression doit spécifier le nom du champ, un opérateur de comparaison et la valeur à utiliser pour le filtrage. La valeur doit être une chaîne, un nombre ou une valeur booléenne. L'opérateur de comparaison doit être =, !=, > ou <.

Par exemple, si vous filtrez une liste de diffusions d'annonces, vous pouvez exclure celles nommées example-announcement en spécifiant name != "example-announcement".

Vous pouvez également filtrer les champs imbriqués.

Pour filtrer sur plusieurs expressions, indiquez chaque expression distincte entre parenthèses. Exemple :

(name = "example-announcement")
(createTime > "2021-04-12T08:15:10.40Z")

Par défaut, chaque expression est une expression AND. Toutefois, vous pouvez inclure explicitement les expressions AND et OR. Exemple :

(name = "announcement-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "announcement-2")
orderBy

string

Trie les résultats de la liste selon un certain ordre. Par défaut, les résultats renvoyés sont triés par name dans l'ordre croissant. Vous pouvez également trier les résultats dans l'ordre décroissant en fonction de la valeur name à l'aide de orderBy="name desc". Pour le moment, seul le tri par name est disponible.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour VmwareEngine.ListAnnouncements

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
announcements[]

object (Announcement)

Liste des exécutions d'annonces.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
unreachable[]

string

une liste des emplacements inaccessibles.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.