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.

Recuperar uma conta

PDFs

GET /accounts/{account_id}

Retorna o recurso da API Account armazenado no corpo da resposta JSON.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID da coleção de contas a ser listada

  • exemplo: {{.Account}}

Resposta

Status: 200, Returns the stored Account API resource in the JSON response body.
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

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

  • "application/astra-account"

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

nome

string

Verdadeiro

String JSON contendo um nome para a conta. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL.

estado

string

Verdadeiro

String JSON contendo um valor que indica o estado operacional da conta. Os valores definidos são:

  • "Pendente" - As alterações só podem ser feitas nos recursos de usuário e função da conta (valor padrão)

  • "ativo" - Alterações podem ser feitas em qualquer recurso da conta

  • "deletePending" - Os usuários não podem fazer login, as operações de proteção de dados estão suspensas, as cobranças não são mais acumuladas

isEnabled

string

Verdadeiro

String JSON indicando que a conta está ativada. Os valores definidos são:

  • "falso" - Os usuários não têm permissão para usar esta conta

  • "verdadeiro" - Os usuários têm permissão para usar esta conta

enabledTimestamp

string

Falso

String JSON contendo o registro de data e hora que indica quando a conta foi ativada pela última vez. Se a conta nunca foi ativada, este campo estará ausente. Os valores definidos são:

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

accountContact

"accountContact"

Falso

Objeto JSON contendo informações de contato do usuário para criar um usuário proprietário no momento da ativação da conta.

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.
Exemplo de resposta 
{
  "type": "application/astra-account",
  "version": "1.0",
  "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
  "name": "fraught-pines",
  "state": "active",
  "isEnabled": "true",
  "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
  "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

postalAddress

Objeto JSON contendo uma coleção de strings JSON que especificam um endereço. Se esta chave não existir, indica que um endereço não foi fornecido. Se esta chave existir, todas as seis strings JSON contidas estarão presentes. Se você não fornecer nada, a string estará vazia.

Nome Tipo Obrigatório Descrição

addressCountry

string

Verdadeiro

Cadeia JSON contendo o nome ou código do país associado ao endereço postal, conforme especificado na norma ISO 3166 Alpha-2. Os valores definidos são:

  • Comprimento mínimo: 2

  • Comprimento máximo: 2

addressLocality

string

Verdadeiro

String JSON contendo a localidade (por exemplo, cidade) associada ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

addressRegion

string

Verdadeiro

String JSON contendo a região (por exemplo, estado) associada ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

postalCode

string

Verdadeiro

String JSON contendo o código postal associado ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

streetAddress1

string

Verdadeiro

String JSON contendo o endereço da rua associado ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

streetAddress2

string

Falso

String JSON contendo informações opcionais de endereço de rua, caixa postal e outros dados adicionais. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

accountContact

Objeto JSON contendo informações de contato do usuário para criar um usuário proprietário no momento da ativação da conta.

Nome Tipo Obrigatório Descrição

firstName

string

Verdadeiro

String JSON contendo um nome próprio longo especificado pelo usuário. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL.

lastName

string

Verdadeiro

String JSON contendo o sobrenome completo especificado pelo usuário. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL.

companyName

string

Falso

String JSON contendo o nome da empresa associada ao usuário. Se essa chave não existir, indica que nenhum nome de empresa foi fornecido. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL.

e-mail

string

Verdadeiro

Cadeias JSON contendo um endereço de e-mail especificado pelo usuário. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

telefone

string

Falso

String JSON contendo o número de telefone do usuário. Se essa chave não existir, indica que um número de telefone não foi fornecido. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 31

postalAddress

"postalAddress"

Verdadeiro

Objeto JSON contendo uma coleção de strings JSON que especificam um endereço. Se esta chave não existir, indica que um endereço não foi fornecido. Se esta chave existir, todas as seis strings JSON contidas estarão presentes. Se você não fornecer nada, a string estará vazia.

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

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