Method: projects.locations.announcements.list

Lista Announcements para uma determinada região e projeto.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do local para o qual os comunicados serão consultados. Os nomes de recursos são URIs sem esquema que seguem as convenções em https://cloud.google.com/apis/design/resource_names. Por exemplo: projects/my-project/locations/us-west1-a

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

  • vmwareengine.announcements.list

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de anúncios a serem retornados em uma página. O serviço pode retornar um valor inferior a este. O valor máximo é convertido para 1.000. O valor padrão desse campo é 500.

pageToken

string

Um token de página recebido de uma chamada announcements.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para announcements.list precisam corresponder à chamada que forneceu o token da página.

filter

string

Uma expressão de filtro que corresponde aos recursos retornados na resposta. A expressão precisa especificar o nome do campo, um operador de comparação e o valor que você quer usar para filtrar. O valor precisa ser uma string, um número ou um booleano. O operador de comparação precisa ser =, !=, > ou <.

Por exemplo, se você estiver filtrando uma lista de veiculações de anúncios, poderá excluir as chamadas example-announcement especificando name != "example-announcement".

Também é possível filtrar campos aninhados.

Para filtrar várias expressões, coloque cada uma entre parênteses. Exemplo:

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

Por padrão, cada expressão é uma expressão AND. No entanto, é possível incluir expressões AND e OR explicitamente. Exemplo:

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

string

Classifica os resultados da lista em uma determinada ordem. Por padrão, os resultados retornados são ordenados por name em ordem crescente. Também é possível classificar os resultados em ordem decrescente com base no valor name usando orderBy="name desc". No momento, só é possível ordenar por name.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para VmwareEngine.ListAnnouncements.

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

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

object (Announcement)

Uma lista de execuções de anúncios.

nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

unreachable[]

string

lista de locais inacessíveis

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.