Skip to main content
Astra Automation
Uma versão mais recente deste produto está disponível.
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Liste todos os direitos

PDFs

GET /accounts/{account_id}/core/v1/entitlements

Retorna uma matriz JSON com todos os recursos correspondentes na coleção. Se campos individuais forem especificados na solicitação, a matriz JSON de itens conterá os campos solicitados para cada recurso correspondente na ordem especificada.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

incluir

string

consulta

Falso

Indica quais campos devem ser retornados ao listar uma coleção.

Exemplos de URL: "include=id", "include=id,name"

Exemplos OpenAPI: "id"

  • exemplo: produto,entitlementType,entitlementValue, alocação

limite

string

consulta

Falso

Indica o número máximo de recursos a serem retornados ao listar uma coleção.

Exemplos de URL: "limit=2"

Exemplos OpenAPI: "2"

filtro

string

consulta

Falso

Indica quais campos devem ser correspondidos para retornar um recurso ao listar uma coleção.

Os operadores suportados são:

  • eq - Igualdade

  • lt/gt - Menor que/Maior que

  • lte/gte - Menor ou igual a/Maior ou igual a

Exemplo de URL: "filter=field%20eq%20%27value%27"

Exemplos OpenAPI: "campo eq 'valor'"

Ordenar

string

consulta

Falso

Indica a ordem de classificação dos recursos ao listar uma coleção.

Exemplos de URL: "orderBy=name", "orderBy=name%20desc"

Exemplos OpenAPI: "nome desc"

ignorar

string

consulta

Falso

Indica o número de recursos a serem ignorados ao listar uma coleção.

Exemplos de URL: "skip=1"

Exemplos OpenAPI: "1"

contar

string

consulta

Falso

Indica se o número total de recursos deve ser retornado no objeto metadados.

Exemplos de URL: "count=true"

Exemplos OpenAPI: "true"

continuar

consulta

Falso

Indica o token a partir do qual a listagem será retomada.

Exemplos de URL: "continue="

Exemplos OpenAPI: ""</continue>

Resposta

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Nome Tipo Obrigatório Descrição

itens

array[Qualquer um de: "entitlement_1.0_get_response_body", array[]]

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "type": "application/astra-entitlements",
  "version": "1.0",
  "items": [
    [
      "Astra SDS",
      "capacity",
      "2",
      null
    ],
    [
      "Astra Enterprise",
      "clusters",
      "100",
      "5e9fe8f7-4c54-441c-ac94-fd8451f9ca38"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Resposta

Status: 401, Unauthorized
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Resposta

Status: 400, Bad request
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidParams

array["invalidParams"]

Falso

Lista de parâmetros de consulta inválidos
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Resposta

Status: 403, Forbidden
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erro

Status: 404, Not found
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta de erro 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definições

Ver definições

tipo_astra_label

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

valor

string

Verdadeiro

tipo_metadados_astra

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Verdadeiro

CriaçãoTimestamp

string

Verdadeiro

Alteração do Timestamp

string

Verdadeiro

CreatedBy

string

Verdadeiro

modifiedBy

string

Falso

entitlement_1.0_get_response_body

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

Tipo de mídia do recurso. Os valores definidos são:

  • "application/astra-entitlement"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

id

string

Verdadeiro

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

alocação

string

Falso

String JSON contendo o ID do objeto ao qual o direito está alocado. Presente apenas quando o direito está alocado. O conteúdo da string não foi validado pelo esquema.

produto

string

Falso

Cadeia JSON contendo a string do produto extraída da licença ou assinatura. O conteúdo da string não foi validado pelo esquema.

productVersion

string

Falso

String JSON contendo a string de versão extraída da licença ou assinatura. O conteúdo da string não foi validado pelo esquema.

entitlementType

string

Verdadeiro

String JSON contendo o tipo de direito. Este valor é extraído da licença ou assinatura. O conteúdo da string não foi validado pelo esquema.

entitlementValue

string

Verdadeiro

String JSON contendo a capacidade associada ao entitlement. O conteúdo da string não foi validado pelo esquema.

entitlementConsumption

string

Falso

String JSON contendo a quantidade de capacidade associada à licença que está atualmente em uso. O conteúdo da string não foi validado pelo esquema.

sourceLicense

string

Falso

String JSON contendo o ID do objeto de licença do qual a entitlement é originada. Os valores definidos são:

  • Conforme o esquema de identificador Astra

sourceSubscription

string

Falso

String JSON contendo o ID do objeto de assinatura do qual o direito é originado. Os valores definidos são:

  • Conforme o esquema de identificador Astra

validFromTimestamp

string

Falso

String JSON contendo um carimbo de data/hora indicando quando o direito se torna válido. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

validUntilTimestamp

string

Falso

String JSON contendo um carimbo de data/hora indicando quando o direito deixa de ser válido. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

metadados

"tipo_metadados_astra"

Verdadeiro

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

type_astra_metadata_list

Nome Tipo Obrigatório Descrição

continuar

string

Falso

contar

número

Falso

etiquetas

array["tipo_astra_label"]

Falso

CriaçãoTimestamp

string

Falso

Alteração do Timestamp

string

Falso

CreatedBy

string

Falso

modifiedBy

string

Falso

invalidParams

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do parâmetro de consulta inválido

razão

string

Verdadeiro

Motivo pelo qual o parâmetro de consulta é inválido