Consulta de la política de copia de respaldo vinculada al almacén de protección HSS
Función
Esta API se utiliza para consultar la política de copia de respaldo asociada al almacén de protección HSS. Asegúrese de que se haya adquirido un almacén de protección contra ransomware en CBR. Dicho almacén se denomina en el formato HSS_projectid.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/backup/policy
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto Mínimo: 1 Máximo: 256 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps. Valor predeterminado: 0 Mínimo: 1 Máximo: 256 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. Mínimo: 1 Máximo: 32768 |
region |
Sí |
String |
ID de región Mínimo: 0 Máximo: 128 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
enabled |
Boolean |
Si la política está habilitada |
id |
String |
ID de política Mínimo: 1 Máximo: 128 |
name |
String |
Nombre de política Mínimo: 1 Máximo: 128 |
operation_type |
String |
Tipo de copia de respaldo. Su valor puede ser:
Mínimo: 1 Máximo: 128 |
operation_definition |
OperationDefinitionInfo object |
Atributo de política. Regla reservada. |
trigger |
BackupTriggerInfo object |
Regla de programación de políticas de copia de respaldo |
Parámetro |
Tipo |
Descripción |
---|---|---|
day_backups |
Integer |
Cantidad máxima de copias de respaldo diarios retenidos. La última copia de respaldo de cada día se guarda a largo plazo. Este parámetro no se ve afectado por el número máximo de copias de respaldo retenidas. El valor oscila entre 0 y 100. Si se especifica este parámetro, se debe configurar la zona horaria. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
max_backups |
Integer |
Número máximo de copias de respaldo automatizadas que se pueden conservar para un objeto. El valor puede ser -1 u oscilar entre 0 y 99999. Si el valor se establece en -1, las copias de respaldo no se borrarán aunque se supere el límite de cantidad de copias de respaldo retenidas configurado. Si este parámetro y retention_duration_days se dejan en blanco al mismo tiempo, las copias de respaldo se conservarán de forma permanente. Valor mínimo: 1. Valor máximo: 99999. Valor predeterminado: -1 Mínimo: -1 Máximo: 99999 |
month_backups |
Integer |
Cantidad máxima de copias de respaldo mensuales retenidos. La última copia de respaldo de cada mes se guarda a largo plazo. Este parámetro no se ve afectado por el número máximo de copias de respaldo retenidas. El valor oscila entre 0 y 100 Si se especifica este parámetro, se debe configurar la zona horaria. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
días_duración_de_retención |
entera |
Duración de la retención de una copia de respaldo, en días. El valor máximo es 99999. Si el valor se establece en -1, las copias de respaldo no se borrarán aunque se supere la duración de retención configurada. Si este parámetro y max_backups se dejan en blanco al mismo tiempo, las copias de respaldo se conservarán permanentemente. Valor mínimo: 1. Valor máximo: 99999. Valor predeterminado: -1 Mínimo: -1 Máximo: 99999 |
zona horaria |
Cuerda |
Zona horaria en la que se encuentra el usuario, por ejemplo, UTC+08:00. Establezca este parámetro solo después de haber configurado cualquiera de los parámetros day_backups, week_backups, month_backups, and year_backups. Mínimo: 0 Máximo: 256 |
week_backups |
Integer |
Cantidad máxima de copias de respaldo semanales retenidos. La última copia de respaldo de cada semana se guarda a largo plazo. Este parámetro puede ser efectivo junto con el número máximo de copias de respaldo retenidas especificado por max_backups. El valor oscila entre 0 y 100. Si se especifica este parámetro, se debe configurar la zona horaria. Mínimo: 0 Máximo: 100 |
year_backups |
Integer |
Cantidad máxima de copias de respaldo anuales retenidos. La última copia de respaldo de cada año se guarda a largo plazo. Este parámetro puede ser efectivo junto con el número máximo de copias de respaldo retenidas especificado por max_backups. El valor oscila entre 0 y 100. Si se especifica este parámetro, se debe configurar la zona horaria. Valor mínimo: 0. Valor máximo: 100 Mínimo: 0 Máximo: 100 |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID del programador Mínimo: 0 Máximo: 256 |
name |
String |
Nombre de programador Mínimo: 0 Máximo: 256 |
type |
String |
Tipo de programador. Actualmente, solo se puede configurar la hora. Mínimo: 0 Máximo: 256 |
properties |
BackupTriggerPropertiesInfo object |
Atributo del programador |
Parámetro |
Tipo |
Descripción |
---|---|---|
pattern |
Array of strings |
Política de programación. El valor contiene un máximo de 10,240 caracteres y cumple con iCalendar RFC 2445. Sin embargo, solo se admiten FREQ, BYDAY, BYHOUR y BYMINUTE. FREQ se puede configurar solo como WEEKLY or DAILY. BYDAY se puede configurar en los siete días de una semana (MO, TU, WE, TH, FR, SA y SU). BYHOUR se puede configurar entre 0 y 23 horas. BYMINUTE se puede configurar entre 0 y 59 minutos. El intervalo entre puntos temporales no puede ser inferior a una hora. Se pueden configurar múltiples puntos de tiempo de copia de respaldo en una política de copia de respaldo y se pueden configurar hasta 24 puntos de tiempo para un día. Mínimo: 0 Máximo: 256 Longitud de matriz: 0 - 24 |
start_time |
String |
Hora de inicio del programador. Por ejemplo: 2020-01-08 09:59:49 Mínimo: 0 Máximo: 256 |
Solicitudes de ejemplo
Esta API se utiliza para consultar la política de copia de respaldo asociada con el almacén.
GET https://{endpoint}/v5/{project_id}/backup/policy
Ejemplo de respuestas
Código de estado: 200
Información de políticas de copia de respaldo
{ "enabled" : true, "id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda", "name" : "HSS_84b5266c14ae489fa6549827f032dc62", "operation_type" : "backup", "operation_definition" : { "day_backups" : 0, "max_backups" : "-1", "month_backups" : 0, "retention_duration_days" : 5, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ] } } }
Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ShowBackupPolicyInfoSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ShowBackupPolicyInfoRequest request = new ShowBackupPolicyInfoRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); try { ShowBackupPolicyInfoResponse response = client.showBackupPolicyInfo(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBackupPolicyInfoRequest() request.enterprise_project_id = "<enterprise_project_id>" response = client.show_backup_policy_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowBackupPolicyInfoRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest response, err := client.ShowBackupPolicyInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Más información
Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en API Explorer. El código de ejemplo del SDK se puede generar automáticamente.
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Información de políticas de copia de respaldo |
Códigos de error
Consulte Códigos de error.