Listar los volúmenes de una app
GET /accounts/{account_id}/k8s/v1/apps/{app_id}/volumes
Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
app_id |
cadena |
ruta |
Verdadero |
ID del recurso que contiene la aplicación |
incluya |
cadena |
consulta |
Falso |
Indica qué campos deben devolverse al listar una colección. Ejemplos de URL: "include=id", "include=id,name" Ejemplos OpenAPI: "id"
|
límite |
cadena |
consulta |
Falso |
Indica el número máximo de recursos a devolver al listar una colección. Ejemplos de URL: "limit=2" Ejemplos OpenAPI: "2" |
Respuesta
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.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
artículos |
array[Cualquiera de: "volume_1.2_get_response_body", array[]] |
Verdadero |
|
metadatos |
Verdadero |
Ejemplo de respuesta
{
"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"
}
}
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 |
matriz["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 |
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 |
volume_1.2_get_response_body
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene el nombre del volumen. Los valores definidos son:
|
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:
|
snapshotPossible |
cadena |
Falso |
Cadena JSON que indica si el controlador puede realizar una instantánea del volumen. Los valores definidos son:
|
storageClass |
cadena |
Falso |
Cadena JSON que contiene la clase de almacenamiento del volumen.
|
pvcName |
cadena |
Falso |
Cadena JSON que contiene el nombre PersistentVolumeClaim (PVC) del volumen.
|
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.
|
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:
|
storageBackendID |
cadena |
Falso |
Cadena JSON que contiene el ID del backend de almacenamiento que proporciona el volumen. Los valores definidos son:
|
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:
|
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:
|
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:
|
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.
|
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
type_astra_metadata_list
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
continuar |
cadena |
Falso |
|
cuente |
número |
Falso |
|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
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 |