Modificación de una política
Función
Esta API se utiliza para modificar una política.
URI
PUT /v3/{project_id}/policies/{policy_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
policy_id |
Sí |
String |
ID de política |
project_id |
Sí |
String |
ID de proyecto |
Parámetros 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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
policy |
Sí |
PolicyUpdate object |
Cuerpo de solicitud de modificación de una política |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enabled |
No |
Boolean |
Si se debe habilitar la política Predeterminado: true |
name |
No |
String |
Nombre de política Mínimo: 1 Máximo: 64 |
operation_definition |
No |
PolicyoODCreate object |
Parámetro de programación |
trigger |
No |
PolicyTriggerReq object |
Regla de tiempo para la ejecución de la política |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
day_backups |
No |
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 |
No |
String |
ID del proyecto de destino de replicación, que es obligatorio para la replicación entre regiones |
destination_region |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
properties |
Sí |
PolicyTriggerPropertiesReq object |
Atributos del programador |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
pattern |
Sí |
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 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
policy |
Policy object |
Respuesta a la solicitud de creación de una 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:
|
trigger |
PolicyTriggerResp object |
Regla de programación de tiempo para la política |
associated_vaults |
Array of PolicyAssociateVault objects |
Almacén asociado |
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 |
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:
|
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 |
Solicitudes de ejemplo
PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff { "policy" : { "enabled" : true, "name" : "policy001", "operation_definition" : { "day_backups" : 0, "month_backups" : 0, "max_backups" : 1, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } } } }
Ejemplo de respuestas
Código de estado: 200
OK
{ "policy" : { "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" : { "max_backups" : 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" } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
Códigos de error
Consulte Códigos de error.