Obtener información de configuración de copia de seguridad del servicio
Obtiene la información de configuración de copia de seguridad del servicio Service Fabric.
Obtiene la información de configuración de copia de seguridad de Service Fabric para el servicio y las particiones de este servicio.
Solicitud
Método | URI de solicitud |
---|---|
GET | /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parámetros
Nombre | Tipo | Requerido | Location |
---|---|---|---|
serviceId |
string | Sí | Ruta de acceso |
api-version |
string | Sí | Consultar |
ContinuationToken |
string | No | Consultar |
MaxResults |
entero (int64) | No | Consultar |
timeout |
entero (int64) | No | Consultar |
serviceId
Tipo: cadena
Obligatoria: sí
La identidad del servicio. Este identificador suele ser el nombre completo del servicio sin el esquema de URI "fabric:".
A partir de la versión 6.0, los nombres jerárquicos se delimitan con el carácter "~".
Por ejemplo, si el nombre del servicio es "fabric:/myapp/app1/svc1", la identidad de servicio sería "myapp~app1~svc1" en 6.0+ y "myapp/app1/svc1" en las versiones anteriores.
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 más reciente admitida de la API. Si se pasa una versión de API inferior, 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 admitida 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 6.0 y el runtime 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 6.0 documentada.
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 información de configuración de copia de seguridad para el servicio y las particiones de este servicio, para las que se ha invalidado la configuración de copia de seguridad. |
PagedBackupConfigurationInfoList |
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 la configuración de copia de seguridad de este servicio y particiones en este servicio. El número de resultados de una página se limita al máximo de dos mediante el parámetro MaxResult.
Request
GET http://localhost:19080/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2
Respuesta 200
Cuerpo
{
"ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"Items": [
{
"Kind": "Service",
"PolicyName": "BackupPolicy1",
"PolicyInheritedFrom": "Application",
"ServiceName": "fabric:/CalcApp/CalcService",
"SuspensionInfo": {
"IsSuspended": false,
"SuspensionInheritedFrom": "Invalid"
}
},
{
"Kind": "Partition",
"PolicyName": "BackupPolicy2",
"PolicyInheritedFrom": "Partition",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"SuspensionInfo": {
"IsSuspended": false,
"SuspensionInheritedFrom": "Invalid"
}
}
]
}
Página con token de continuación
En este ejemplo se muestra cómo obtener una lista de la configuración de copia de seguridad de este servicio y particiones en este servicio. El número de resultados de una página se limita al máximo de dos mediante el parámetro MaxResult. 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 ContinuationToken vacío. El objeto ContinuationToken vacío indica que los resultados adicionales no están disponibles.
Request
GET http://localhost:19080/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d&MaxResults=2
Respuesta 200
Cuerpo
{
"ContinuationToken": "",
"Items": [
{
"Kind": "Partition",
"PolicyName": "BackupPolicy1",
"PolicyInheritedFrom": "Application",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6",
"SuspensionInfo": {
"IsSuspended": true,
"SuspensionInheritedFrom": "Partition"
}
}
]
}