Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Cloud Backup and Recovery/ Referencia de la API/ APIs de CBR/ Políticas/ Consulta de la lista de política

Actualización más reciente 2023-02-03 GMT+08:00

Ver PDF

Consulta de la lista de política

Función

Esta API se utiliza para consultar la lista de políticas.

URI

GET /v3/{project_id}/policies

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
operation_type	No	String	Tipo de política, que es de backup Valores de enumeración: backup replication
vault_id	No	String	ID de almacén

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
policies	Array of Policy objects	Lista de políticas
count	Integer	Número total de políticas

**Tabla 5** Política
Parámetro	Tipo	Descripción
enabled	Boolean	Si la política está habilitada
id	String	ID de política
name	String	Nombre de política
operation_definition	PolicyoODCreate object	Atributos de política
operation_type	String	Tipo de protección, que es de backup Valores de enumeración: backup
trigger	PolicyTriggerResp object	Regla de programación de tiempo para la política
associated_vaults	Array of PolicyAssociateVault objects	Almacén asociado

**Tabla 6** PolicyoODCreate
Parámetro	Tipo	Descripción
day_backups	Integer	Especifica el número de copias de seguridad diarias retenidas. La última copia de respaldo de cada día se guarda a largo plazo. Este parámetro puede ser efectivo junto con el número máximo de copias de seguridad retenidas especificado por max_backups. El valor varía de 0 a 100. Si este parámetro está configurado, timezone es obligatoria. Mínimo: 0 Máximo: 100
destination_project_id	String	ID del proyecto de destino de replicación, que es obligatorio para la replicación entre regiones
destination_region	String	ID de la región de destino de replicación, que es obligatorio para la replicación entre regiones. El valor consta de 0 a 255 caracteres y solo puede contener letras, dígitos, guiones bajos (_) y guiones (-).
enable_acceleration	Boolean	Si se habilita la función de aceleración para acortar el tiempo de replicación para la replicación entre regiones. Si este parámetro no está definido, la función de aceleración está deshabilitada.
max_backups	Integer	Número máximo de copias de seguridad retenidas. El valor puede ser -1 o oscila entre 0 y 99999. Si el valor se establece en -1, las copias de seguridad no se borrarán aunque se exceda la cantidad de copias de seguridad retenidas configurada. Si este parámetro y retention_duration_days se dejan en blanco, las copias de seguridad se conservarán de forma permanente. Mínimo: 1 Máximo: 99999 Predeterminado: -1
month_backups	Integer	Especifica el número de copias de seguridad mensuales retenidas. La última copia de respaldo de cada mes se guarda a largo plazo. Este parámetro puede ser efectivo junto con el número máximo de copias de seguridad retenidas especificado por max_backups. El valor varía de 0 a 100. Si este parámetro está configurado, timezone es obligatoria. Mínimo: 0 Máximo: 100
retention_duration_days	Integer	Duración de la retención de una copia de respaldo, en días. El valor máximo es 99999. -1 indica que las copias de seguridad no se borrarán en función de la duración de retención. Si este parámetro y max_backups se dejan en blanco al mismo tiempo, las copias de seguridad se conservarán permanentemente. Mínimo: 1 Máximo: 99999 Predeterminado: -1
timezone	String	Zona horaria donde se encuentra el usuario, por ejemplo, UTC+08:00. Establezca este parámetro si ha configurado cualquiera de los parámetros: day_backups, week_backups, month_backups, year_backups.
week_backups	Integer	Especifica el número de copias de seguridad semanales retenidas. 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 seguridad retenidas especificado por max_backups. El valor varía de 0 a 100. Si este parámetro está configurado, timezone es obligatoria.
year_backups	Integer	Especifica el número de copias de seguridad anuales retenidas. 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 seguridad retenidas especificado por max_backups. El valor varía de 0 a 100. Si este parámetro está configurado, timezone es obligatoria. Mínimo: 0 Máximo: 100

**Tabla 7** PolicyTriggerResp
Parámetro	Tipo	Descripción
id	String	ID del programador
name	String	Nombre de programador
properties	PolicyTriggerPropertiesResp object	Atributos del programador
type	String	Tipo de programador. Actualmente, solo se admite time (programación periódica). Valores de enumeración: time

**Tabla 8** PolicyTriggerPropertiesResp
Parámetro	Tipo	Descripción
pattern	Array of strings	Regla de programación del programador. Se puede configurar un máximo de 24 reglas. La regla de programación cumple con iCalendar RFC 2445, pero solo admite los parámetros FREQ, BYDAY, BYHOUR, BYMINUTE, y INTERVAL. FREQ solo se puede establecer en WEEKLY o DAILY. BYDAY se puede ajustar a MO, TU, WE, TH, FR, SA, y SU (siete días de una semana). BYHOUR varía de 0 a 23 horas. BYMINUTE varía de 0 a 59 minutos. El intervalo de programación no puede ser inferior a 1 hora. Se permite un máximo de 24 puntos de tiempo en un día. Por ejemplo, si la hora de programación es 14:00 (UTC) de lunes a domingo, establezca la regla de programación de la siguiente manera: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. Si la hora de programación es 14:00 (UTC+8) todos los días, establezca la regla de programación de la siguiente manera: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00
start_time	String	Hora de inicio del programador, por ejemplo, 2020-01-08 09:59:49

**Tabla 9** PolicyAssociateVault
Parámetro	Tipo	Descripción
destination_vault_id	String	ID del almacén remoto asociado
vault_id	String	ID de almacén

Solicitudes de ejemplo

GET  https://{endpoint}/v3/{project_id}/policies

Ejemplo de respuestas

Código de estado: 200

{
  "policies" : [ {
    "name" : "policy001",
    "associated_vaults" : [ ],
    "enabled" : true,
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
        "start_time" : "2019-05-08 06:57:05"
      },
      "type" : "time",
      "id" : "d67269a6-5369-42d7-8150-5254bd446328",
      "name" : "default"
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "year_backups" : 0,
      "day_backups" : 0,
      "month_backups" : 0,
      "week_backups" : 0,
      "timezone" : "UTC+08:00"
    },
    "operation_type" : "backup",
    "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
  } ],
  "count" : 10
}