- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Permissões do IAM
- Uso
Agrega o uso por instância para uma configuração.
Solicitação HTTP
GET https://licensemanager.googleapis.com/v1/{name=projects/*/locations/*/configurations/*}:aggregateUsage
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
Obrigatório. Valor principal para AggregateUsageRequest |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado. |
pageToken |
Opcional. Um token que identifica a página de resultados que o servidor retornará. |
filter |
Opcional. Como filtrar resultados |
orderBy |
Opcional. Dica de como organizar os resultados. |
startTime |
Obrigatório. As licenças são compradas por mês. Portanto, o rastreamento do uso precisa do horário de início de um mês. Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, |
endTime |
Obrigatório. O período de uso é sempre de um mês. Esse parâmetro é para o horário de término do mês. Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Mensagem de resposta para agregar a contagem de uso
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"usages": [
{
object ( |
Campos | |
---|---|
usages[] |
Os registros agregados de uso por configuração |
nextPageToken |
Um token que identifica a página de resultados que o servidor retornará. |
unreachable[] |
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 mais informações, consulte o Authentication Overview.
Permissões do IAM
Requer a seguinte permissão do IAM no recurso name
:
licensemanager.configurations.aggregateUsage
Para mais informações, consulte a documentação do IAM.
Uso
Mensagem que descreve o número total de usuários que acessaram uma VM.
Representação JSON |
---|
{ "limaInstance": string, "users": integer } |
Campos | |
---|---|
limaInstance |
Nome do recurso da instância do LiMa, ou seja, projects/{project}/locations/{location}/instances/{instance} |
users |
Número de usuários únicos que acessam a VM. |