Share via

Obtener todas las entidades de las que se hace una copia de seguridad por directiva

  • Artículo

Obtiene la lista de entidades de copia de seguridad asociadas a esta directiva.

Devuelve una lista de aplicaciones, servicios o particiones de Service Fabric que están asociados a esta directiva de copia de seguridad.

Solicitud

Método URI de solicitud
GET /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parámetros

Nombre Tipo Requerido Location
backupPolicyName string Sí Ruta de acceso
api-version string Sí Consultar
ContinuationToken string No Consultar
MaxResults entero (int64) No Consultar
timeout entero (int64) No Consultar

backupPolicyName

Tipo: cadena
Obligatoria: sí

Nombre de la directiva de copia de seguridad.

api-version

Tipo: cadena
Obligatoria: sí
Predeterminado:

La versión de la API. Este parámetro es necesario y su valor debe ser "6.4".

La versión de la API REST de Service Fabric se basa en la versión en tiempo de ejecución en la que se introdujo o se cambió la API. El entorno de ejecución de Service Fabric admite más de una versión de la API. Esta versión es la versión compatible más reciente de la API. Si se pasa una versión de API anterior, la respuesta devuelta puede ser diferente de la documentada en esta especificación.

Además, el tiempo de ejecución acepta cualquier versión superior a la versión compatible más reciente hasta la versión actual del entorno de ejecución. Por lo tanto, si la versión más reciente de la API es la 6.0 y el entorno de ejecución es 6.1, el entorno de ejecución aceptará la versión 6.1 para esa API. Sin embargo, el comportamiento de la API será según la versión documentada 6.0.

ContinuationToken

Tipo: cadena
Obligatoria: no

El parámetro continuation token se utiliza para obtener el siguiente conjunto de resultados. Un token de continuación con un valor no vacío se incluye en la respuesta de la API cuando los resultados del sistema no caben en una única respuesta. Cuando este valor se pasa a la siguiente llamada de la API, la API devuelve el siguiente conjunto de resultados. Si no hay más resultados, el token de continuación no contiene ningún valor. El valor de este parámetro no debe ser la dirección URL codificada.

MaxResults

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMinimum: 0

El número máximo de resultados que se devuelven como parte de las consultas paginadas. Este parámetro define el límite superior en el número de resultados devueltos. Los resultados devueltos pueden ser menos que el número máximo de resultados especificado si no caben en el mensaje según las restricciones del tamaño máximo del mensaje definidas en la configuración. Si este parámetro es cero o no se especifica, la consulta paginada incluye tantos resultados como quepan en el mensaje devuelto.

timeout

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tiempo de espera del servidor para realizar la operación en segundos. Este tiempo de espera especifica el tiempo que el cliente está dispuesto a esperar a que se complete la operación solicitada. El valor predeterminado para este parámetro es 60 segundos.

Respuestas

Código de estado HTTP Descripción Esquema de respuesta
200 (OK) Una operación correcta devolverá el código de estado 200 y una lista paginada de entidades de Service Fabric asociadas a esta directiva.
 PagedBackupEntityList
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

Limitar los resultados máximos

En este ejemplo se muestra cómo obtener una lista de entidades de copia de seguridad asociadas actualmente a una directiva de copia de seguridad. El número de resultados en una página se limita al máximo de dos mediante el parámetro MaxResult.

Request

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&MaxResults=2

Respuesta 200

Cuerpo
{
  "ContinuationToken": "fabric:/DemoApp",
  "Items": [
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/CalcApp"
    },
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/DemoApp"
    }
  ]
}

Página con token de continuación

En este ejemplo se muestra cómo obtener una lista de entidades de copia de seguridad asociadas actualmente a una directiva de copia de seguridad. En este ejemplo se usa el parámetro ContinuationToken. El valor de este parámetro se proporciona a partir de la consulta anterior; en este caso, el ejemplo mostrado anteriormente. La respuesta contiene los resultados restantes y un Objeto ContinuationToken vacío. El objeto ContinuationToken vacío indica que los resultados adicionales no están disponibles.

Request

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken=fabric:/DemoApp&MaxResults=2

Respuesta 200

Cuerpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "EntityKind": "Service",
      "ServiceName": "fabric:/VotingApp/VotingActorService"
    }
  ]
}