Consulta de uma política única
Função
Esta API é usada para consultar uma única política.
URI
GET /v3/{project_id}/policies/{policy_id}
| 
        Parâmetro  | 
      
        Obrigatório  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|---|
| 
        policy_id  | 
      
        Sim  | 
      
        String  | 
      
        ID da política  | 
     
| 
        project_id  | 
      
        Sim  | 
      
        String  | 
      
        ID do projeto  | 
     
Parâmetros de solicitação
| 
        Parâmetro  | 
      
        Obrigatório  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        Sim  | 
      
        String  | 
      
        Token de usuário. O token pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. Padrão: MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...  | 
     
Parâmetros de resposta
Código de status: 200
| 
        Parâmetro  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|
| 
        policy  | 
      
        Policy object  | 
      
        Resposta ao pedido de criação de uma política  | 
     
| 
        Parâmetro  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|
| 
        enabled  | 
      
        Boolean  | 
      
        Se a política está habilitada  | 
     
| 
        id  | 
      
        String  | 
      
        ID da política  | 
     
| 
        name  | 
      
        String  | 
      
        Nome da política  | 
     
| 
        operation_definition  | 
      
        PolicyoODCreate object  | 
      
        Atributos da política  | 
     
| 
        operation_type  | 
      
        String  | 
      
        Tipo de proteção, que pode ser backup ou replication Valores de enumeração: 
  | 
     
| 
        trigger  | 
      
        PolicyTriggerResp object  | 
      
        Regra de programação de tempo para a política  | 
     
| 
        associated_vaults  | 
      
        Array of PolicyAssociateVault objects  | 
      
        Cofre associado  | 
     
| 
        Parâmetro  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|
| 
        day_backups  | 
      
        Integer  | 
      
        Especifica o número de backups diários retidos. O último backup de cada dia é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100  | 
     
| 
        destination_project_id  | 
      
        String  | 
      
        ID do projeto de destino de replicação, que é obrigatório para a replicação entre regiões  | 
     
| 
        destination_region  | 
      
        String  | 
      
        ID da região de destino da replicação, que é obrigatório para a replicação entre regiões. O valor consiste de 0 a 255 caracteres e pode conter apenas letras, dígitos, sublinhado (_) e hifens (-).  | 
     
| 
        enable_acceleration  | 
      
        Boolean  | 
      
        Se ativar a função de aceleração para encurtar o tempo de replicação para replicação entre regiões. Se este parâmetro não estiver definido, a função de aceleração é desativada.  | 
     
| 
        max_backups  | 
      
        Integer  | 
      
        Número máximo de backups retidos. O valor pode ser -1 ou varia de 0 a 99999. Se o valor for definido como -1, os backups não serão apagados mesmo que a quantidade de backup retida configurada seja excedida. Se esse parâmetro e a retention_duration_days forem deixados em branco, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1  | 
     
| 
        month_backups  | 
      
        Integer  | 
      
        Especifica o número de backups mensais retidos. O último backup de cada mês é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100  | 
     
| 
        retention_duration_days  | 
      
        Integer  | 
      
        Duração da retenção de um backup, em dias. O valor máximo é 99999. -1 indica que os backups não serão limpos com base na duração da retenção. Se este parâmetro e max_backups forem deixados em branco ao mesmo tempo, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1  | 
     
| 
        timezone  | 
      
        String  | 
      
        Fuso horário em que o usuário está localizado, por exemplo, UTC+08:00. Defina este parâmetro se tiver configurado algum dos parâmetros: day_backups, week_backups, month_backups, year_backups.  | 
     
| 
        week_backups  | 
      
        Integer  | 
      
        Especifica o número de backups semanais retidos. O último backup de cada semana é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório.  | 
     
| 
        year_backups  | 
      
        Integer  | 
      
        Especifica o número de backups anuais retidos. O último backup de cada ano é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100  | 
     
| 
        Parâmetro  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|
| 
        id  | 
      
        String  | 
      
        ID do agendador  | 
     
| 
        name  | 
      
        String  | 
      
        Nome do agendador  | 
     
| 
        properties  | 
      
        PolicyTriggerPropertiesResp object  | 
      
        Atributos do agendador  | 
     
| 
        type  | 
      
        String  | 
      
        Tipo de agendador. Atualmente, apenas time (agendamento periódico) é suportado. Valores de enumeração: 
  | 
     
| 
        Parâmetro  | 
      
        Tipo  | 
      
        Descrição  | 
     
|---|---|---|
| 
        pattern  | 
      
        Array of strings  | 
      
        Regra de programação do agendador. Um máximo de 24 regras podem ser configuradas. A regra de agendamento está em conformidade com o iCalendar RFC 2445, mas suporta apenas os parâmetros FREQ, BYDAY, BYHOUR, BYMINUTE e INTERVAL. FREQ pode ser definido apenas para WEEKLY ou DAILY. BYDAY pode ser definido como MO, TU, WE, TH, FR, SA e SU (sete dias por semana). BYHOUR varia de 0 a 23 horas. BYMINUTE varia de 0 a 59 minutos. O intervalo de agendamento não pode ser inferior a 1 hora. Um máximo de 24 pontos de tempo são permitidos em um dia. Por exemplo, se o horário de agendamento for 14:00 (UTC) de segunda a domingo, defina a regra de agendamento da seguinte forma: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. Se o horário de agendamento for 14:00 (UTC+8) todos os dias, defina a regra de agendamento da seguinte forma: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00  | 
     
| 
        start_time  | 
      
        String  | 
      
        Hora de início do agendador, por exemplo, 2020-01-08 09:59:49  | 
     
Exemplo de solicitações
GET  https://{endpoint}/v3/{project_id}/policies/{policy_id}
 Exemplo de respostas
Código de status: 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" : {
      "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"
  }
}
 Códigos de status
| 
        Código de status  | 
      
        Descrição  | 
     
|---|---|
| 
        200  | 
      
        OK  | 
     
Códigos de erro
Consulte Códigos de erro.