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.

Enumera los recursos de AppMirror para una app

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

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

  • ejemplo: {{.Account}}

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"

filtro

cadena

consulta

Falso

Indica qué campos deben coincidir para devolver un recurso al listar una colección.

Los operadores admitidos son:

  • eq - Igualdad

  • lt/gt - menor que/mayor que

  • lte/gte - Menor o igual que/Mayor o igual que

Ejemplo de URL: "filter=field%20eq%20%27value%27"

Ejemplos OpenAPI: "field eq 'value'"

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

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero

Ejemplo de respuesta
{
  "type": "application/astra-appMirrors",
  "version": "1.0",
  "items": [
    {
      "type": "application/astra-appMirror",
      "version": "1.0",
      "id": "f1c98c2e-6391-42d3-8b21-3e75dac048a3",
      "sourceAppID": "efd639b6-fc92-4112-8841-0c0ab7890ae0",
      "sourceClusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
      "destinationAppID": "cd7b6d91-fc19-4983-a754-9a7bb4d80a7b",
      "destinationClusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
      "namespaceMapping": [
        {
          "clusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
          "namespaces": [
            "ns1-src",
            "ns2-src"
          ]
        },
        {
          "clusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
          "namespaces": [
            "ns1-dest",
            "ns2-dest"
          ]
        }
      ],
      "state": "established",
      "stateTransitions": [
        {
          "from": "establishing",
          "to": [
            "established",
            "deleting"
          ]
        },
        {
          "from": "established",
          "to": [
            "failingOver",
            "deleting"
          ]
        },
        {
          "from": "failingOver",
          "to": [
            "failedOver",
            "deleting"
          ]
        },
        {
          "from": "failedOver",
          "to": [
            "establishing",
            "deleting"
          ]
        },
        {
          "from": "deleting",
          "to": [
            "deleted"
          ]
        }
      ],
      "stateDesired": "established",
      "stateAllowed": [
        "failedOver",
        "deleted"
      ],
      "stateDetails": [
        {
          "type": "https://astra.netapp.io/stateDetails/1",
          "title": "AppMirror relationship established",
          "detail": "The AppMirror relationship has been successfully established."
        }
      ],
      "healthState": "normal",
      "healthStateTransitions": [
        {
          "from": "indeterminate",
          "to": [
            "normal",
            "warning",
            "critical"
          ]
        },
        {
          "from": "normal",
          "to": [
            "indeterminate",
            "warning",
            "critical"
          ]
        },
        {
          "from": "warning",
          "to": [
            "indeterminate",
            "normal",
            "critical"
          ]
        },
        {
          "from": "critical",
          "to": [
            "indeterminate",
            "normal",
            "warning"
          ]
        }
      ],
      "healthStateDetails": [
        {
          "type": "https://astra.netapp.io/stateDetails/2",
          "title": "SnapMirror syncing successfully",
          "detail": "All SnapMirror relationships are synchronizing as expected."
        }
      ],
      "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"
  }
}

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

namespaceMapping

Nombre Tipo Obligatorio Descripción

clusterID

cadena

Falso

Identificador del clúster para el que se especifican los espacios de nombres. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

espacios de nombres

array[string]

Falso

Lista de espacios de nombres a utilizar en el clúster. Correlacionado con la otra lista de espacios de nombres del clúster por índice. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Cumple con el esquema de etiquetas DNS 1123

storageClasses

Nombre Tipo Obligatorio Descripción

clusterID

cadena

Falso

Identificador del clúster para el que se especifica la clase de almacenamiento. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

storageClassName

cadena

Falso

Nombre de la clase de almacenamiento que se utilizará al crear PVC en el clúster especificado en "clusterID". Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 255

type_astra_stateTransition

Nombre Tipo Obligatorio Descripción

de

cadena

Verdadero

a

array[string]

Verdadero

type_astra_stateDetail

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

etiqueta_tipo_astra

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

valor

cadena

Verdadero

type_astra_metadatos_update

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

  • Se ajusta al esquema de metadatos de Astra Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

Nombre Tipo Obligatorio Descripción

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

modifiedBy

cadena

Falso

appMirror_1.0_get_response_body

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-appMirror"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

id

cadena

Verdadero

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

  • Cumple con el esquema UUIDv4

sourceAppID

cadena

Verdadero

Identificador de la aplicación de origen. Solo se actualiza al intercambiar el sourceAppID con el destinationAppID. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

sourceClusterID

cadena

Verdadero

Identificador del clúster gestionado que aloja la aplicación de origen. Este campo es de solo lectura y se determina en función del clúster host de la aplicación de origen. Si se proporciona en una actualización, debe coincidir con el ID de clúster de la aplicación de origen, así que solo puede cambiar al intercambiar el sourceAppID con el destinationAppID. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

destinationAppID

cadena

Falso

Identificador de la aplicación de destino. No se puede proporcionar al crear porque se generará un nuevo app ID como parte de la inicialización de la relación. Solo se puede actualizar al intercambiar sourceAppID con destinationAppID. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

destinationClusterID

cadena

Verdadero

Identificador del clúster gestionado para alojar la aplicación de destino. Debe proporcionarse al crear porque determina en qué clúster se creará la aplicación de destino. Si se proporciona al actualizar, debe coincidir con el ID de clúster de la aplicación de destino, por lo que solo puede cambiar al intercambiar sourceAppID con destinationAppID. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

namespaceMapping

array["namespaceMapping"]

Falso

El espacio o espacios de nombres que se utilizarán al crear la aplicación de destino, correspondientes a los espacios de nombres de la aplicación de origen. Cada objeto JSON contiene los campos "clusterID" y "namespaces", donde el valor "clusterID" es el ID de cadena JSON del clúster de origen o destino, y el valor "namespaces" es una matriz JSON de cadenas JSON. Debe haber exactamente un objeto JSON por cada clúster, y los namespaces se correlacionarán por índice. Si no se proporciona, se utilizará el mismo namespace del clúster de origen en el clúster de destino. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 2

storageClasses

array["storageClasses"]

Falso

La clase de almacenamiento que se utilizará en el clúster de destino al crear nuevas Reclamaciones de Volumen Persistente (PVC). Cada objeto JSON contiene los campos "clusterID" y "storageClassName", donde el valor "clusterID" es el ID de cadena JSON del clúster de origen o clúster de destino, y el valor "storageClassName" es la clase de almacenamiento que se utilizará al crear PVC en ese clúster. Si no se proporciona o si falta el valor para un clúster, se utilizará la clase de almacenamiento predeterminada para ese clúster. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 2

estado

cadena

Verdadero

El estado de la relación. Los valores definidos son:

  • "establecer" - Se está creando la relación.

  • "establecido" - Se crea la relación.

  • "failingOver" - La conmutación por error de la aplicación al clúster de destino está en curso.

  • "failedOver" - Se ha completado la conmutación por error de la aplicación al clúster de destino.

  • "borrando" - Se están limpiando los recursos creados por la relación.

  • "deleted" - La relación se limpió y eliminó.

stateTransitions

array["type_astra_stateTransition"]

Falso

Transiciones de estado permitidas. Las siguientes transiciones de estado son posibles para este recurso:

  • "estableciendo": "establecido", "eliminando"

  • "established": "failingOver", "deleting"

  • "failingOver": "failedOver", "deleting"

  • "failedOver": "establishing", "deleting"

  • "borrar": "borrado"

  • "borrado":

stateDesired

cadena

Verdadero

Estado deseado para la relación. En el momento de la creación, el único valor válido es "establecido". Los valores definidos son:

  • "establecido" - Se crea la relación.

  • "failedOver" - Se ha completado la conmutación por error de la aplicación al clúster de destino.

  • "deleted" - La relación se limpió y eliminó correctamente.

stateAllowed

array[string]

Falso

Estados que pueden solicitarse en un estado determinado. Los siguientes estados pueden solicitarse en cada estado definido:

  • "establishing": "established", "deleted"

  • "establecido": "failedOver", "eliminado"

  • "failingOver": "failedOver", "deleted"

  • "failedOver": "establecido", "eliminado"

  • "borrar": "borrado"

  • "deleted": "deleted"

stateDetails

array["type_astra_stateDetail"]

Verdadero

Detalles adicionales sobre el estado actual, incluyendo por qué se alcanzó el estado actual. Si no hay detalles disponibles, esta matriz estará vacía. Los valores definidos son:

  • Artículos mínimos: 0

transferState

cadena

Falso

Estado de la transferencia de instantáneas actual o más reciente. Los valores definidos son:

  • "transfiriendo" - Se ha creado una nueva instantánea y ahora se está replicando en el clúster de destino. Este estado también cubre las transferencias que han fallado en intentos anteriores y se están reintentando continuamente.

  • "idle" - actualmente no hay ninguna transferencia en curso.

transferStateTransitions

array["type_astra_stateTransition"]

Falso

Transiciones de estado permitidas desde un estado definido dado. Las siguientes transiciones de estado son posibles para este recurso:

  • "transferring": "idle"

  • "inactivo": "transfiriendo"

transferStateDetails

array["type_astra_stateDetail"]

Falso

Detalles adicionales sobre el estado actual, incluyendo por qué se alcanzó el estado actual. Si no hay detalles disponibles, esta matriz estará vacía. Los valores definidos son:

  • Artículos mínimos: 0

healthState

cadena

Verdadero

Estado de salud del recurso. 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

healthStateTransitions

array["type_astra_stateTransition"]

Verdadero

Transiciones de estado permitidas desde un estado definido dado. Las siguientes transiciones de estado son posibles para este recurso:

  • "indeterminado": "normal", "advertencia", "crítico"

  • "normal": "indeterminado", "advertencia", "crítico"

  • "advertencia": "indeterminado", "normal", "crítico"

  • "crítico": "indeterminado", "normal", "advertencia"

healthStateDetails

array["type_astra_stateDetail"]

Verdadero

Detalles adicionales sobre el estado actual, incluyendo por qué se alcanzó el estado actual. Si no hay detalles disponibles, esta matriz estará vacía. Los valores definidos son:

  • Artículos mínimos: 0

metadatos

"type_astra_metadatos_update"

Verdadero

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

  • Se ajusta al esquema de metadatos de Astra Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

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