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 os volumes de um aplicativo

PDFs

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/volumes

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

app_id

string

caminho

Verdadeiro

ID do recurso do aplicativo que o contém

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: id, nome

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"

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

Verdadeiro

metadados

"type_astra_metadata_list"

Verdadeiro
Exemplo de resposta 
{
  "type": "application/astra-volumes",
  "version": "1.2",
  "items": [
    [
      "24fe6e79-bf8d-45c9-96af-ef1d11fbd4a0",
      "myVolume"
    ],
    [
      "20a370f4-957f-446a-9126-08853d01933a",
      "secondVol"
    ],
    [
      "48e349a2-5bcd-4c59-896c-12b8240e634b",
      "smallVol"
    ]
  ],
  "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

type_astra_stateDetail

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

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

volume_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-volume"

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

nome

string

Verdadeiro

String JSON contendo o nome do volume. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

estado

string

Falso

Cadeia JSON contendo um valor que indica o estado operacional do volume.

tamanho

string

Falso

Cadeia JSON contendo o tamanho do volume.

usado

número

Falso

Número JSON contendo o número de bytes da cota utilizada pelo volume provisionado.

usedPercentage

número

Falso

Número JSON contendo a porcentagem do volume utilizado.

total

número

Falso

Número JSON contendo o total de bytes dos volumes provisionados.

creationToken

string

Falso

String JSON contendo o token de criação do volume. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

snapshotPossible

string

Falso

String JSON que indica se o driver pode realizar um snapshot do volume. Os valores definidos são:

  • "verdadeiro" - O driver pode tirar um snapshot do volume

  • "falso" - O driver não pode tirar uma captura instantânea do volume

storageClass

string

Falso

String JSON contendo a classe de armazenamento do volume.

  • Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

pvcName

string

Falso

Cadeia JSON contendo o nome PersistentVolumeClaim (PVC) do volume.

  • Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

internalName

string

Falso

String JSON contendo o nome interno do volume no cluster de armazenamento de destino, se disponível. Esse nome é obtido do driver CSI do Kubernetes.

  • Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 255

appsUsing

array[string]

Verdadeiro

Matriz JSON de strings JSON, cada uma contendo o ID de um aplicativo que está usando o volume. Os valores definidos são:

  • Conforme o esquema de identificador Astra

ID do backend de armazenamento

string

Falso

String JSON contendo o ID do backend de armazenamento que fornece o volume. Os valores definidos são:

  • Conforme o esquema de identificador Astra

orquestrador

string

Falso

String JSON contendo o orquestrador para este volume. Isso será definido para volumes do Astra Data Store. Os valores definidos são:

  • "trident" - Trident forneceu este volume

  • "vasa" - NetApp VASA Provider disponibilizou este volume

  • "other" - O volume foi provisionado manualmente ou o orquestrador é desconhecido

serviceLevel

string

Falso

String JSON contendo a política de qualidade do serviço (QoS) definida para este volume no nível do backend de armazenamento. Isso será definido para volumes do Astra Data Store.

exportPolicy

string

Falso

String JSON contendo a política de exportação associada a este volume. Isso será definido para volumes do Astra Data Store.

nodeId

string

Falso

String JSON contendo o ID do nó que serve o volume. Isso será definido para volumes do Astra Data Store. Os valores definidos são:

  • Conforme o esquema de identificador Astra

healthState

string

Falso

String JSON contendo um valor que indica o estado de integridade do volume. Isso será definido para volumes do Astra Data Store. Os valores definidos são:

  • "Indeterminado" - O estado de saúde do recurso não pode ser determinado (por exemplo, devido à falta de conectividade)

  • "normal" - O recurso não apresenta problemas conhecidos e pode fornecer serviços de acordo com a especificação da interface

  • "Aviso" - O recurso apresenta problemas conhecidos que não o impedem de fornecer serviços de acordo com a especificação da interface

  • "Crítico" - O recurso apresenta problemas conhecidos que o impedem de fornecer serviços de acordo com a especificação da interface

healthStateDetails

array["type_astra_stateDetail"]

Verdadeiro

Matriz JSON de objetos JSON que lista detalhes adicionais sobre o estado de saúde atual. Se não houver detalhes disponíveis, essa matriz estará vazia.

  • Quantidade mínima de itens: 0

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