Skip to main content
Astra Automation
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 todas as assinaturas

PDFs

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

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}}

continuar

consulta

Falso

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

Exemplos de URL: "continue="

Exemplos OpenAPI: ""</continue>

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"

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'"

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"

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"

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"

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: "subscription_1.2_get_response_body", array[]]

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "type": "application/astra-subscriptions",
  "version": "1.2",
  "items": [
    {
      "type": "application/astra-subscription",
      "version": "1.1",
      "id": "d4c865c9-64a7-4661-ae4a-3307dffcd3da",
      "customerProfileID": "2157047189",
      "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
      "paymentExpiry": "2022-02-01T00:00:00Z",
      "purchaseOrderNumber": "72384632",
      "marketplace": "netapp",
      "licenseSN": "278343",
      "terms": "trial",
      "status": "inactive",
      "appLimit": 0,
      "namespaceLimit": 10,
      "subscriptionPeriod": 90,
      "gracePeriod": 7,
      "reminderBeforePeriod": 30,
      "onboardStatus": "success",
      "costPerAppUnit": 0,
      "costPerNamespaceUnit": 0.005,
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-05-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-05-06T12:24:52.256624Z",
        "createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
      }
    },
    {
      "type": "application/astra-subscription",
      "version": "1.1",
      "id": "4c43ed8b-078f-4fe3-b8c6-5d515f6382e6",
      "customerProfileID": "2157047189",
      "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
      "paymentExpiry": "2022-05-01T00:00:00Z",
      "purchaseOrderNumber": "92374658",
      "marketplace": "netapp",
      "licenseSN": "374623",
      "terms": "paid",
      "status": "active",
      "appLimit": 0,
      "namespaceLimit": -1,
      "subscriptionPeriod": -1,
      "gracePeriod": -1,
      "reminderBeforePeriod": -1,
      "onboardStatus": "success",
      "costPerAppUnit": 0,
      "costPerNamespaceUnit": 0.005,
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
      }
    }
  ],
  "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

type_astra_metadados_update

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

  • Conforme o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Falso

CriaçãoTimestamp

string

Falso

Alteração do Timestamp

string

Falso

CreatedBy

string

Falso

modifiedBy

string

Falso

subscription_1.2_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-subscription"

versão

string

Verdadeiro

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

  • "1,0"

  • "1,1"

  • "1,2"

id

string

Verdadeiro

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

  • Em conformidade com o esquema UUIDv4

ID do perfil do cliente

string

Verdadeiro

String JSON contendo o ID do perfil do cliente de "Authorize.net", que foi invocada pela interface do usuário, não está definida para o período de carência. Retorna uma string vazia durante a operação de leitura, caso não esteja definida. Os valores definidos são:

  • Comprimento mínimo: 0

  • Comprimento máximo: 63

ID do perfil de pagamento

string

Falso

String JSON contendo o ID do perfil de pagamento "Authorize.net" que foi invocado pela interface do usuário, não definido para o período de avaliação. Retorna uma string vazia durante a operação de leitura se não estiver definido. Os valores definidos são:

  • Comprimento mínimo: 0

  • Comprimento máximo: 63

paymentExpiry

string

Falso

String JSON contendo um timestamp indicando quando o método de pagamento expira. Este valor é obtido do authorize.net(http://authorize.net e definido pela interface do usuário. Os valores definidos são:

  • Em conformidade com o padrão de data e hora ISO-8601 Este campo não é retornado durante o período de avaliação.

purchaseOrderNumber

string

Falso

String JSON contendo o número do pedido de compra para o método de pagamento. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

marketplace

string

Falso

String JSON que indica o marketplace para uma conta onde os pagamentos serão registrados. Valores definidos:

  • "netapp"

  • "azure"

  • "aws"

  • "gcp"

licenseSN

string

Falso

String JSON contendo o número de série da licença para o método de pagamento. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

termos

string

Verdadeiro

String JSON que indica o nível atual da conta. Os valores definidos são:

  • "teste"

  • "pago"

status

string

Verdadeiro

String JSON que indica o status atual da assinatura. Os valores definidos são:

  • "ativo"

  • "inativo"

appLimit

número

Verdadeiro

Número JSON que indica o limite de aplicativos para esta assinatura. O valor -1 indica que não há limite.

namespaceLimit

número

Verdadeiro

Número JSON que indica o limite de namespace para esta assinatura. Valor -1 indica que não há limite.

subscriptionPeriod

número

Verdadeiro

Número JSON que indica o período de assinatura. O valor -1 indica que não há limite. Unidade: dias

gracePeriod

número

Verdadeiro

Número JSON que indica o período de carência após o término da assinatura de avaliação ou o cancelamento de uma assinatura paga. Unidade: dias

reminderBeforePeriod

número

Verdadeiro

Número JSON que indica a quantidade de dias antes do término da assinatura de avaliação, quando as notificações ao cliente serão iniciadas. O valor é expresso em dias, sendo -1 indicativo de que não se aplica.

onboardStatus

string

Verdadeiro

String JSON que indica o status atual do processo de integração do cliente. Os valores válidos são "não iniciado", "em andamento", "sucesso", "falha". Os valores definidos são:

  • "não iniciado"

  • "em andamento"

  • "sucesso"

  • "falhou"

costPerAppUnit

número

Verdadeiro

Número JSON que indica o custo por unidade do aplicativo. Para uma versão de avaliação, o valor é 0. Unidade: dólares americanos

costPerNamespaceUnit

número

Verdadeiro

Número JSON que indica o custo por unidade de namespace. Para uma versão de avaliação, o valor é 0. Unidade: dólares americanos

metadados

"type_astra_metadados_update"

Verdadeiro

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

  • Conforme o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.

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