Licenças da plataforma UIP

Sintaxe e opções para "licenças de plataforma uip", que relata a alocação de consumíveis no nível da organização e o consumo por tenant.

uip platform licenses é o relatório de consumíveis no nível da organização. Ele responde a três perguntas: como cada consumível é alocado e consumido entre os tenants hoje, quanto de um determinado consumível um tenant queimou por dia em uma janela e quais pastas dentro de um tenant direcionaram esse consumo.

Para alterações de alocação por tenant, use uip platform tenants licenses. Para pacotes por usuário, use uip platform users licenses.

Resumo

uip platform licenses consumables <verb> [options]
uip platform licenses summary [options]

Verbo

Texto	Finalidade
consumables get	Obtenha um relatório de consumíveis. O padrão --mode summary retorna a alocação por consumível mais o consumo de pool por tenant. --mode daily retorna o detalhamento diário por serviço e --mode folders retorna o detalhamento por pasta — ambos com escopo para um único tenant × unidade de consumíveis.
summary	Get the consolidated organization license summary: robots, user-bundle licenses, and consumables in one flat table.

os consumíveis de licenças da plataforma uip obter

Obtenha um relatório de consumíveis. O sinalizador --mode seleciona uma das três formas:

• summary padrão) — uma linha por consumível × tenant. Os totais no nível da organização (totalUnitsInAccount, allocated, consumedFromOrgWithoutTenant) e as datas dos pacotes se repetem nas linhas. As colunas por tenant dividem o consumo entre o pool do próprio tenant (consumedFromTenantPool) e o pool de organizações compartilhado (consumedFromOrgPool). Os consumíveis sem atividade de tenant obtêm uma única linha de resumo com colunas de tenant vazias.
• daily — uma linha por (date, service) para um único tenant × unidade de consumível em um intervalo de datas ISO 8601. Requer --tenant, --unit, --start-date e --end-date.
• folders uma linha por pasta dentro de um único tenant × unidade de consumíveis, com o consumo próprio (não herdado) e a contagem de processos dessa pasta. Requer --tenant, --unit, --start-date e --end-date.

Sem --start-date e --end-date, o relatório summary usa a janela de validade do pacote de cada consumível. Fornecer a eles substitui essa janela apenas para o relatório — as alocações subjacentes permanecem inalteradas.

Opções

Long	Valor	Padrão	Description
--mode	ENUM	summary	Formato do relatório: summary, daily ou folders.
--tenant	tenant-name	—	Defina o escopo do relatório para um único tenant (correspondente ao nome da lista de tenants da organização atual). Necessário para --mode daily e --mode folders.
--unit	code	—	Filtra para uma única unidade de consumível por código de produto (por exemplo, AIU, AGU, RU, PLTU). Sem distinção entre maiúsculas e minúsculas. Necessário para --mode daily e --mode folders.
--start-date	Data ISO 8601	—	Início da janela de consumo. Deve ser usado com --end-date. Obrigatório para --mode daily e --mode folders.
--end-date	Data ISO 8601	—	Fim da janela de consumo. Deve ser usado com --start-date. Obrigatório para --mode daily e --mode folders.

--start-date deve ser estritamente antes de --end-date, e ambos os sinalizadores devem ser fornecidos juntos (passar apenas um será rejeitado).

Exemplos

Relatório de resumo padrão:

uip platform licenses consumables get

Intervalo de datas personalizado para o resumo:

uip platform licenses consumables get \
    --start-date 2025-01-01 --end-date 2025-01-31

Faça o escopo do resumo para um único tenant:

uip platform licenses consumables get --tenant default

Divisão diária por serviço para um tenant × unidade:

uip platform licenses consumables get \
    --mode daily --tenant default --unit AIU \
    --start-date 2025-01-01 --end-date 2025-01-31

Detalhamento de pastas para um tenant × unidade:

uip platform licenses consumables get \
    --mode folders --tenant default --unit AIU \
    --start-date 2025-01-01 --end-date 2025-01-31

Formato dos dados (--output json)

Modo de resumo — Code: "LicensesConsumablesSummary":

{
  "Code": "LicensesConsumablesSummary",
  "Data": [
    {
      "code": "AIU",
      "name": "AI Units",
      "totalUnitsInAccount": 5000,
      "allocated": 1200,
      "consumedFromOrgWithoutTenant": 30,
      "startDate": "2023-11-14T22:13:20.000Z",
      "endDate": "2027-09-15T18:40:00.000Z",
      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
      "tenantName": "default",
      "consumedFromTenantPool": 800,
      "consumedFromOrgPool": 150
    }
  ]
}

Modo diário — Code: "LicensesConsumablesDaily":

{
  "Code": "LicensesConsumablesDaily",
  "Data": [
    {
      "code": "AIU",
      "name": "AI Units",
      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
      "tenantName": "default",
      "date": "2025-01-15",
      "service": "orchestrator",
      "consumedAmount": 24
    }
  ]
}

Modo de pastas — Code: "LicensesConsumablesFolders":

{
  "Code": "LicensesConsumablesFolders",
  "Data": [
    {
      "code": "AIU",
      "name": "AI Units",
      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
      "tenantName": "default",
      "folderKey": "11111111-1111-1111-1111-111111111111",
      "folderName": "Shared",
      "parentFolderKey": null,
      "consumedBySelf": 42,
      "processCountSelf": 3
    }
  ]
}

uip platform licenses summary

Get the consolidated organization license summary: robots (total & allocated), user-bundle licenses (total & used), and consumables (total, allocated & used) — all as one flat table of rows tagged by category, so it stays filterable (for example --output-filter "[?Category=='Robot']").

Unlike consumables get, this is a single, ungated call — no --mode, --tenant, or date range required.

Opções

Long	Valor	Padrão	Description
--organization	ID da conta	padrão da sessão	Organization account GUID.

Exemplos

uip platform licenses summary
uip platform licenses summary --output-filter "[?Category=='Consumable']" --output table

Formato dos dados (--output json)

{
  "Code": "LicensesSummary",
  "Data": [
    {
      "category": "Robot",
      "code": "RU",
      "name": "Robot Units",
      "total": 25,
      "allocated": 10,
      "used": null,
      "available": 15,
      "startDate": null,
      "endDate": null
    },
    {
      "category": "User license",
      "code": "RPADEVPRONU",
      "name": "Automation Developer",
      "total": 60,
      "allocated": null,
      "used": 2,
      "available": 58,
      "startDate": null,
      "endDate": null
    },
    {
      "category": "Consumable",
      "code": "AIU",
      "name": "AI Units",
      "total": 5000,
      "allocated": 1200,
      "used": 980,
      "available": null,
      "startDate": "2023-11-14T22:13:20.000Z",
      "endDate": "2027-09-15T18:40:00.000Z"
    }
  ]
}

Fields that don't apply to a category are null: robots and user licenses have no dates, consumables have no meaningful available, user licenses have no allocated.

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

Comandos relacionados

• uip platform tenants — altere a alocação por tenant que esse relatório mede.
• uip platform users — alocação de pacotes por usuário.

Veja também

• Opções globais.
• Formatos de saída.