DescribePoliciesV2 - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta uma ou mais políticas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:DescribePoliciesV2

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para uma única solicitação. Valores válidos: 10 a 100. Valor padrão: 10.	10
NextToken	string	Não	O token usado para recuperar a próxima página de políticas.	caeba0bbb2be03f84eb48b699f0a
PolicyId	string	Não	O ID da política.	po-000************2l6
RuleScope	string	Não	O escopo usado para filtrar regras ao consultar políticas.	BACKUP
AccountScope	string	Não	O escopo de contas ao qual a política se aplica.	SPECIFIED_ACCOUNT
Accounts	array<object>	Não	A lista de informações de contas especificada ao consultar políticas.
	object	Não
CrossAccountType	string	Não	O tipo de associação de conta, que é usado para distinguir entre a conta atual e cenários de contas cruzadas.	CROSS_ACCOUNT_BY_RD
CrossAccountUserId	integer	Não	O ID da conta Alibaba Cloud da conta cujos recursos precisam ser submetidos a backup.	1234567890123456
CrossAccountRoleName	string	Não	O nome da função do Resource Access Management (RAM) criada na conta cujos recursos precisam ser submetidos a backup.	hbrcrossrole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	DescribePoliciesResponse.
Policies	array<object>	A lista de políticas.
	array<object>	Os detalhes da política.
CreatedTime	integer	A hora de criação. O valor é um timestamp UNIX em segundos.	1650248136
UpdatedTime	integer	A hora de atualização. O valor é um timestamp UNIX em segundos.	1662080404
PolicyId	string	O ID da política.	po-000************bkz
PolicyName	string	O nome da política.	Daily backup + geo-redundancy
PolicyDescription	string	A descrição da política.	Back up at 10:00 AM every day and replicate to Shanghai
Rules	array<object>	A lista de regras da política.
	array<object>	Os detalhes da regra da política.
RuleId	string	O ID da regra.	rule-000************f1e
RuleType	string	O tipo da regra. Cada política deve conter pelo menos uma regra BACKUP e exatamente uma regra TRANSITION. Valores válidos: BACKUP: regra de backup. TRANSITION: regra de ciclo de vida. REPLICATION: regra de replicação.	BACKUP
Schedule	string	A programação de backup. Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP. Formato: `I\|{startTime}\|{interval}`. Este formato especifica que um trabalho de backup é executado em um intervalo de {interval} a partir de {startTime}. Trabalhos de backup perdidos não são compensados. Se o trabalho de backup anterior não for concluído, o próximo trabalho de backup não será acionado. Por exemplo, `I\|1631685600\|P1D` especifica que um trabalho de backup é executado todos os dias a partir das 14:00:00 de 15 de setembro de 2021. startTime: a hora de início do backup. O valor é um timestamp UNIX em segundos. interval: o intervalo de tempo ISO 8601. Por exemplo, PT1H especifica um intervalo de uma hora e P1D especifica um intervalo de um dia.	I\|1648647166\|P1D
BackupType	string	O tipo de backup. Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP. Valor válido: COMPLETE, que especifica um backup completo.	COMPLETE
VaultId	string	O ID do cofre de backup. Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP.	v-000**************kgm
ReplicationRegionId	string	O ID da região de destino para replicação. Este parâmetro é obrigatório apenas quando RuleType é definido como REPLICATION.	cn-shanghai
Retention	integer	O período de retenção. Este parâmetro é obrigatório apenas quando RuleType é definido como TRANSITION ou REPLICATION. Se RuleType for definido como TRANSITION, este parâmetro especifica o período de retenção do backup. O valor mínimo é 1, em dias. Se RuleType for definido como REPLICATION, este parâmetro especifica o período de retenção de georredudância. O valor mínimo é 1, em dias.	7
RetentionRules	array<object>	A lista de regras de retenção especiais. Este parâmetro é obrigatório apenas quando RuleType é definido como TRANSITION.
	object	A regra de retenção especial.
AdvancedRetentionType	string	O tipo da regra de retenção especial. Valores válidos: WEEKLY: backup semanal. MONTHLY: backup mensal. YEARLY: backup anual.	YEARLY
WhichSnapshot	integer	O número de sequência do backup ao qual a regra se aplica. Atualmente, apenas o primeiro backup é suportado. Defina o valor como 1.	1
Retention	integer	O período de retenção especial para o backup. O valor mínimo é 1, em dias.	730
ArchiveDays	integer	O número de dias após os quais o backup é transferido para o armazenamento de arquivamento. Este parâmetro é obrigatório apenas quando RuleType é definido como TRANSITION. Unidade: dias.	30
KeepLatestSnapshots	integer	Especifica se deve ser retida pelo menos uma versão de backup. Valores válidos: 0: não. 1: sim.	1
DataSourceFilters	array<object>	As regras de filtragem de fonte de dados. Este parâmetro é obrigatório apenas quando RuleType é definido como TAG.
	array<object>
SourceType	string	O tipo de fonte de dados. Valores válidos: UDM_ECS: backup de instância ECS. OSS: backup de OSS. NAS: backup de NAS. ECS_FILE: ECS File Backup Standard Edition. OTS: backup do Tablestore.	UDM_ECS
DataSourceIds `deprecated`	array	[Obsoleto]
`deprecated`	string	[Obsoleto]	[Deprecated]
AccountScope	string	O escopo de contas ao qual a política se aplica.	SPECIFIED_ACCOUNT
Accounts	array<object>	A lista de informações de contas nas condições de filtragem da fonte de dados.
	object
CrossAccountType	string	O tipo de associação de conta, que é usado para distinguir entre a conta atual e cenários de contas cruzadas.	CROSS_ACCOUNT_BY_RD
CrossAccountUserId	integer	O ID da conta Alibaba Cloud da conta cujos recursos precisam ser submetidos a backup.	1234567890123456
CrossAccountRoleName	string	O nome da função do Resource Access Management (RAM) criada na conta cujos recursos precisam ser submetidos a backup.	hbrcrossrole
TagFilters	array<object>	As regras de filtragem de tags de recurso. Este parâmetro é obrigatório apenas quando RuleType é definido como TAG.
	object
Key	string	A chave da tag.	env
Value	string	O valor da tag. Um valor vazio especifica qualquer valor.	prod
Operator	string	A regra de correspondência de tags. Valores válidos: EQUAL: corresponde tanto à chave da tag quanto ao valor da tag. NOT: corresponde à chave da tag, mas não ao valor da tag.	EQUAL
Immutable	boolean	Especifica se o bloqueio de backup deve ser ativado. Este campo é válido apenas quando PolicyType é definido como UDM_ECS_ONLY.	true
PolicyBindingCount	integer	O número de fontes de dados vinculadas à política.	5
PolicyType	string	O tipo de política. Valores válidos: STANDARD: política de backup geral, que oferece suporte ao backup de fontes de dados diferentes de instâncias ECS. UDM_ECS_ONLY: política de backup de instância ECS, que oferece suporte apenas ao backup de instâncias ECS.	STANDARD
BusinessStatus	string	O status comercial do usuário.	ACTIVE
NextToken	string	O token usado para recuperar a próxima página de políticas.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	O número máximo de entradas a serem retornadas para uma única solicitação. Valores válidos: 10 a 100. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas.	12
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: bem-sucedida. false: falha.	true
Code	string	O código de status. Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, successful é retornado. Se a solicitação falhar, uma mensagem de erro é retornada.	successful
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Exemplos

Resposta de sucesso

JSON formato

{
  "Policies": [
    {
      "CreatedTime": 1650248136,
      "UpdatedTime": 1662080404,
      "PolicyId": "po-000************bkz",
      "PolicyName": "Backup diário + backup com redundância geográfica",
      "PolicyDescription": "Fazer backup todos os dias às 10:00 AM e replicar para Xangai",
      "Rules": [
        {
          "RuleId": "rule-000************f1e",
          "RuleType": "BACKUP",
          "Schedule": "I|1648647166|P1D",
          "BackupType": "COMPLETE",
          "VaultId": "v-000**************kgm",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "ArchiveDays": 30,
          "KeepLatestSnapshots": 1,
          "DataSourceFilters": [
            {
              "SourceType": "UDM_ECS",
              "DataSourceIds": [
                "Deprecated"
              ],
              "AccountScope": "SPECIFIED_ACCOUNT",
              "Accounts": [
                {
                  "CrossAccountType": "CROSS_ACCOUNT_BY_RD",
                  "CrossAccountUserId": 1234567890123456,
                  "CrossAccountRoleName": "hbrcrossrole"
                }
              ]
            }
          ],
          "TagFilters": [
            {
              "Key": "env",
              "Value": "prod",
              "Operator": "EQUAL"
            }
          ],
          "Immutable": true
        }
      ],
      "PolicyBindingCount": 5,
      "PolicyType": "STANDARD",
      "BusinessStatus": "ACTIVE"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.