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

Consulta uma ou mais fontes de dados vinculadas a uma política, ou consulta uma ou mais políticas vinculadas a uma fonte de dados.

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:DescribePolicyBindings

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NextToken	string	Não	O token necessário para obter a próxima página de associações entre política e fonte de dados.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	Não	O número de resultados para cada consulta.	10
PolicyId	string	Não	O ID da política.	po-000************hky
DataSourceIds	array	Não	A lista de IDs das fontes de dados.
	string	Não	O ID da fonte de dados.	i-uf6************68n
SourceType	string	Não	O tipo de fonte de dados. Valores válidos:	UDM_ECS
Filters	array<object>	Não	Os filtros de consulta.
	object	Não	Os filtros de consulta.
Key	string	Não	A chave no filtro de consulta. Valores válidos:	DataSourceType
Operator	string	Não	O método de correspondência. Valor padrão: IN. A operação de correspondência (Operator) suportada pela Chave e pelo Valor no filtro. Valores válidos:	IN
Values	array	Não	Os valores a serem correspondidos no filtro de consulta.
	string	Não	Os valores a serem correspondidos no filtro de consulta.	UDM_ECS

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	DescribePolicyBindingsResponse.
PolicyBindings	array<object>	A lista de vínculos de políticas.
	array<object>	Os detalhes de um vínculo de política.
CreatedTime	integer	A hora de criação. Timestamp UNIX, em segundos.	1661399570
UpdatedTime	integer	A hora de atualização. Timestamp UNIX, em segundos.	1653611573
PolicyBindingId	string	O ID do vínculo da política.	pd-000************slc
PolicyBindingDescription	string	A descrição do vínculo da política.	po-000**********eslc-i-uf6**********y5g
PolicyId	string	O ID da política.	po-000************56y
DataSourceId	string	O ID da fonte de dados.	i-8vb************5ly
Disabled	boolean	Indica se a política está efetiva para a fonte de dados.	true
Source	string	Se SourceType estiver definido como OSS, este parâmetro especifica o prefixo a ser submetido a backup. Se não for especificado, todo o diretório raiz do Bucket será submetido a backup.	backup/
Include	string	Este parâmetro é necessário apenas quando SourceType estiver definido como ECS_FILE ou File. Especifica os tipos de arquivo a serem submetidos a backup. Todos os arquivos desses tipos serão submetidos a backup. Máximo de 255 caracteres.	[\".doc\",\".xltm\"]
Exclude	string	Este parâmetro é necessário apenas quando SourceType estiver definido como ECS_FILE ou File. Especifica os tipos de arquivo a serem excluídos do backup. Todos os arquivos desses tipos não serão submetidos a backup. Máximo de 255 caracteres.	[\".doc\",\".xltm\"]
SpeedLimit	string	Este parâmetro é necessário apenas quando SourceType estiver definido como ECS_FILE ou File. Especifica o controle de tráfego de backup. Formato: `{início}{fim}{largura de banda}`. Múltiplas configurações de controle de tráfego são separadas por delimitadores, e os horários de configuração não podem se sobrepor.	0:24:10240
AdvancedOptions	object	As opções avançadas.
UdmDetail	object	As opções avançadas para backup de instância ECS.
ExcludeDiskIdList	array	A lista de IDs de disco a serem excluídos do backup. Este parâmetro é ignorado se `DiskIdList` não estiver vazio.
	string	O ID do disco a ser excluído do backup.	d-bp1************apo
DiskIdList	array	A lista de IDs de disco a serem copiados. Se você deseja copiar todos os discos, deixe este parâmetro vazio.
	string	O ID do disco a ser copiado.	d-bp1************apo
SnapshotGroup	boolean	Indica se deve ser criado um grupo de snapshots consistentes. Você pode criar um grupo de snapshots consistentes apenas quando todos os discos da instância forem ESSDs (Enhanced SSDs).	true
AppConsistent	boolean	Indica se deve ser criado um snapshot consistente com a aplicação. Você pode criar um snapshot consistente com a aplicação apenas quando todos os discos da instância forem ESSDs.	false
RamRoleName	string	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Este parâmetro especifica o nome da função RAM necessária para criar um snapshot consistente com a aplicação.	AliyunECSInstanceForHbrRole
PreScriptPath	string	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Este parâmetro especifica o caminho do script de pré-congelamento executado antes da criação do snapshot consistente com a aplicação.	/tmp/prescript.sh
PostScriptPath	string	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Este parâmetro especifica o caminho do script de pós-descongelamento executado após a criação do snapshot consistente com a aplicação.	/tmp/postscript.sh
EnableFsFreeze	boolean	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Este parâmetro indica se deve ser usado o comando `fsfreeze` do sistema operacional Linux para colocar o sistema de arquivos em estado somente leitura antes de criar um snapshot consistente com a aplicação. O valor padrão é true.	true
TimeoutInSeconds	integer	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Este parâmetro especifica o período de timeout para congelamento de I/O. O valor padrão é 30 segundos.	30
EnableWriters	boolean	Este parâmetro é necessário apenas se AppConsistent estiver definido como true. Indica se deve ser criado um snapshot consistente com a aplicação: true: Cria um snapshot consistente com a aplicação. false: Cria um snapshot consistente com o sistema de arquivos. Valor padrão: true.	true
DestinationKmsKeyId	string	O ID de uma chave gerenciada pelo cliente (CMK) na região de destino. Se você habilitar a replicação entre regiões e especificar este parâmetro, o backup entre regiões será criptografado usando a chave especificada.	4ed37b1e-da51-4187-aceb-9db4f9b7148b
OssDetail	object	As opções avançadas para backup OSS.
InventoryId	string	O nome do inventário OSS. Se você especificar este parâmetro, um inventário OSS será usado para otimização de desempenho. As taxas de armazenamento para arquivos de inventário são cobradas pelo OSS. Leva tempo para gerar um arquivo de inventário OSS. O trabalho de backup pode falhar antes que o arquivo de inventário seja gerado. Você pode aguardar o próximo ciclo de backup para execução.	inventory_test
InventoryCleanupPolicy	string	Indica se o arquivo de inventário deve ser excluído após um backup. Este parâmetro é válido apenas quando um inventário OSS é usado. Valores válidos: NO_CLEANUP: O arquivo de inventário não é excluído. DELETE_CURRENT: O arquivo de inventário atual é excluído. DELETE_CURRENT_AND_PREVIOUS: Todos os arquivos de inventário são excluídos.	DELETE_CURRENT_AND_PREVIOUS
IgnoreArchiveObject	boolean	Indica se objetos de arquivo devem ser excluídos das estatísticas do trabalho de backup e da lista de arquivos com falha.	true
FileDetail	object	As opções avançadas para backup de arquivos.
UseVSS	boolean	Indica se o recurso Volume Shadow Copy Service (VSS) deve ser habilitado. Este recurso está disponível apenas para instâncias Windows. Valores válidos: true: Habilita o recurso VSS. false: Desabilita o recurso VSS.	false
AdvPolicy	boolean	Indica se uma política avançada deve ser usada. Valores válidos: true: Usa uma política avançada. false: Não usa uma política avançada.	false
CommonNasDetail	object	As opções avançadas para NAS local.
FullOnIncrementFail	boolean	Indica se um backup completo deve ser executado caso um backup incremental falhe. Valores válidos: true: Executa um backup completo. false: Não executa um backup completo.	true
FetchSliceSize	integer	O tamanho de um fragmento de backup, que é o número de arquivos.	100000
ClientId	string	O ID do cliente de backup.	c-0001eg6mcvjs93f46s2d
ClusterId	string	O ID do grupo de clientes.	cl-000gkcofngi04j6k680a
CommonFileSystemDetail	object	As opções avançadas para backup de sistema de arquivos em grande escala.
FullOnIncrementFail	boolean	Indica se um backup completo deve ser executado caso um backup incremental falhe. Valores válidos: true: Executa um backup completo. false: Não executa um backup completo.	true
FetchSliceSize	integer	O tamanho de um fragmento de backup, que é o número de arquivos.	100000
SourceType	string	O tipo de fonte de dados. Valores válidos:	UDM_ECS
CrossAccountType	string	O tipo de backup entre contas. Valores válidos:	CROSS_ACCOUNT
CrossAccountUserId	integer	O ID da conta de origem para backup entre contas.	1480************
CrossAccountRoleName	string	O nome da função RAM criada na conta de origem para backup entre contas.	hbrcrossrole
CreatedByTag	boolean	Indica se o recurso foi associado automaticamente por meio de uma tag de recurso da política de backup.	false
HitTags	array<object>	As regras de tag correspondentes.
	object
Key	string	A chave da tag.	env
Value	string	O valor da tag.	prod
Operator	string	A regra de correspondência de tag. EQUAL: Corresponde à chave da tag e ao valor da tag. NOT: Corresponde à chave da tag, mas não ao valor da tag.	EQUAL
NextToken	string	O token necessário para obter a próxima página de vínculos entre política e fonte de dados.	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	O número de resultados para cada consulta.	10
TotalCount	integer	O número total de registros.	38
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Code	string	O código de resposta. 200 indica sucesso.	200
Message	string	A mensagem retornada. "successful" é retornado em caso de sucesso. Uma mensagem de erro é retornada em caso de falha.	successful
RequestId	string	O ID da solicitação.	5225929A-4EBD-55EE-9FE1-4A130E582A76

Exemplos

Resposta de sucesso

JSON formato

{
  "PolicyBindings": [
    {
      "CreatedTime": 1661399570,
      "UpdatedTime": 1653611573,
      "PolicyBindingId": "pd-000************slc",
      "PolicyBindingDescription": "po-000************eslc-i-uf6************y5g",
      "PolicyId": "po-000************56y",
      "DataSourceId": "i-8vb************5ly",
      "Disabled": true,
      "Source": "backup/",
      "Include": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "Exclude": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "SpeedLimit": "0:24:10240",
      "AdvancedOptions": {
        "UdmDetail": {
          "ExcludeDiskIdList": [
            "d-bp1************apo\n"
          ],
          "DiskIdList": [
            "d-bp1************apo\n"
          ],
          "SnapshotGroup": true,
          "AppConsistent": false,
          "RamRoleName": "AliyunECSInstanceForHbrRole",
          "PreScriptPath": "/tmp/prescript.sh",
          "PostScriptPath": "/tmp/postscript.sh",
          "EnableFsFreeze": true,
          "TimeoutInSeconds": 30,
          "EnableWriters": true,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS",
          "IgnoreArchiveObject": true
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": "cl-000gkcofngi04j6k680a"
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole",
      "CreatedByTag": false,
      "HitTags": [
        {
          "Key": "env",
          "Value": "prod",
          "Operator": "EQUAL"
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

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.