Skip to main content
Astra Automation
Hay disponible una nueva versión de este producto.
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Recuperar un volumen para un backend de almacenamiento

PDF

GET /accounts/{account_id}/topology/v1/storageBackends/{storageBackend_id}/volumes/{volume_id}

Devuelve el recurso de la API de volumen almacenado en el cuerpo de respuesta JSON.

Parámetros

Nombre Tipo En Obligatorio Descripción

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

  • ejemplo: {{.Account}}

storageBackend_id

cadena

ruta

Verdadero

ID del recurso storageBackend que lo contiene

volumen_id

cadena

ruta

Verdadero

ID de la colección de volúmenes a listar

Respuesta

Status: 200, Returns the stored Volume API resource in the JSON response body.
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-volume"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

  • "1,1"

  • "1,2"

id

cadena

Verdadero

Identificador único global del recurso. Los valores definidos son:

  • Cumple con el esquema UUIDv4

nombre

cadena

Verdadero

Cadena JSON que contiene el nombre del volumen. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

estado

cadena

Falso

Cadena JSON que contiene un valor que indica el estado operativo del volumen.

tamaño

cadena

Falso

Cadena JSON que contiene el tamaño del volumen.

usado

número

Falso

Número JSON que contiene el número de bytes de cuota utilizados por el volumen aprovisionado.

usedPercentage

número

Falso

Número JSON que contiene el porcentaje de volumen utilizado.

total

número

Falso

Número JSON que contiene el total de bytes de los volúmenes aprovisionados.

creationToken

cadena

Falso

Cadena JSON que contiene el token de creación del volumen. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

snapshotPossible

cadena

Falso

Cadena JSON que indica si el controlador puede realizar una instantánea del volumen. Los valores definidos son:

  • "true" - El controlador puede tomar una instantánea del volumen

  • "false" - El controlador no puede tomar una instantánea del volumen

storageClass

cadena

Falso

Cadena JSON que contiene la clase de almacenamiento del volumen.

  • Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

pvcName

cadena

Falso

Cadena JSON que contiene el nombre PersistentVolumeClaim (PVC) del volumen.

  • Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

internalName

cadena

Falso

Cadena JSON que contiene el nombre interno del volumen en el clúster de almacenamiento de destino, si está disponible. Este nombre se obtiene del controlador CSI de Kubernetes.

  • Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

appsUsing

array[string]

Verdadero

Matriz JSON de cadenas JSON, cada una de las cuales contiene el ID de una aplicación que está utilizando el volumen. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

storageBackendID

cadena

Falso

Cadena JSON que contiene el ID del backend de almacenamiento que proporciona el volumen. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

orquestador

cadena

Falso

Cadena JSON que contiene el orquestador para este volumen. Se definirá para los volúmenes de Astra Data Store. Los valores definidos son:

  • "trident" - Trident ha aprovisionado este volumen

  • "vasa" - NetApp VASA Provider ha aprovisionado este volumen

  • "otro" - El volumen se ha aprovisionado manualmente o se desconoce el orquestador

serviceLevel

cadena

Falso

Cadena JSON que contiene la política de calidad de servicio (QoS) definida para este volumen a nivel de backend de almacenamiento. Se definirá para los volúmenes de Astra Data Store.

exportPolicy

cadena

Falso

Cadena JSON que contiene la política de exportación asociada a este volumen. Se definirá para los volúmenes de Astra Data Store.

nodeId

cadena

Falso

Cadena JSON que contiene el ID del nodo que sirve al volumen. Se definirá para los volúmenes de Astra Data Store. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

healthState

cadena

Falso

Cadena JSON que contiene un valor que indica el estado de salud del volumen. Se definirá para los volúmenes de Astra Data Store. Los valores definidos son:

  • "indeterminado" - No se puede determinar la salud del recurso (por ejemplo, por falta de conectividad)

  • "normal" - El recurso no tiene problemas conocidos y puede prestar servicios de acuerdo con la especificación de la interfaz

  • "advertencia" - El recurso tiene problemas conocidos que no le impiden prestar servicios de acuerdo con la especificación de la interfaz

  • "crítico" - El recurso tiene problemas conocidos que le impiden prestar servicios de acuerdo con la especificación de la interfaz

healthStateDetails

array["type_astra_stateDetail"]

Verdadero

Matriz JSON de objetos JSON que enumera detalles adicionales sobre el estado de salud actual. Si no hay detalles disponibles, esta matriz estará vacía.

  • Artículos mínimos: 0

metadatos

"tipo_astra_metadatos"

Verdadero

Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:

  • Cumple con el esquema de metadatos Astra
Ejemplo de respuesta 
{
  "type": "application/astra-volume",
  "version": "1.2",
  "id": "ab5c9fb8-ddba-526f-8bd3-8d5b72cf4f7f",
  "name": "myVolume",
  "state": "ready",
  "size": "512 GiB",
  "used": 10000000000,
  "usedPercentage": 10,
  "total": 10000000000,
  "creationToken": "ba7d4e0c-6ae3-4b6e-859d-9463e7ca4b4e",
  "snapshotPossible": "true",
  "storageClass": "gold",
  "pvcName": "myVolume",
  "internalName": "trident_sd234234_23424_897d_876sd65w",
  "appsUsing": [],
  "orchestrator": "trident",
  "serviceLevel": "gold",
  "exportPolicy": "astra-vp-default",
  "nodeId": "94d16dd2-9beb-4edb-ab58-1a00e9a90052",
  "healthState": "normal",
  "healthStateDetails": [],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Respuesta

Status: 401, Unauthorized
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Respuesta

Status: 400, Bad request
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

invalidParams

array["invalidParams"]

Falso

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

Respuesta

Status: 403, Forbidden
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Error

Status: 404, Not found
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Definiciones

Ver definiciones

additionalDetails

type_astra_stateDetail

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

additionalDetails

"additionalDetails"

Falso

etiqueta_tipo_astra

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

valor

cadena

Verdadero

tipo_astra_metadatos

Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:

  • Cumple con el esquema de metadatos Astra

Nombre Tipo Obligatorio Descripción

etiquetas

array["etiqueta_tipo_astra"]

Verdadero

CreationTimestamp

cadena

Verdadero

Modificación.Marca de hora

cadena

Verdadero

CreatedBy

cadena

Verdadero

modifiedBy

cadena

Falso

invalidParams

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

Nombre del parámetro de consulta no válido

motivo

cadena

Verdadero

Razón por la que el parámetro de consulta no es válido