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

Vincula uma ou mais origens de dados a uma política.

Descrição da operação

Cada chamada suporta a vinculação apenas de origens de dados do mesmo tipo à mesma política.
Uma instância ECS pode ser vinculada a apenas uma política.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PolicyId	string	Não	O ID da política.	po-000************8ep
PolicyBindingList	array<object>	Não	A lista de vinculações de política.
	array<object>	Não	Os detalhes da vinculação de política.
PolicyBindingDescription	string	Não	A descrição da vinculação de política.	This is a description of the policy binding
DataSourceId	string	Não	O ID da origem de dados. O significado varia com base no campo SourceType: UDM_ECS: O ID da instância ECS. OSS: O nome do bucket do OSS. NAS: O ID do sistema de arquivos NAS do Alibaba Cloud. COMMON_NAS: O ID da instância NAS local. ECS_FILE: O ID da instância ECS. File: O ID do cliente do Cloud Backup. COMMON_FILE_SYSTEM: O ID da origem de dados para CPFS (backup baseado em agente). CPFS: O ID do sistema de arquivos CPFS (backup sem agente).	i-bp1************dl8
Disabled	string	Não	Especifica se a política está suspensa para a origem de dados. Valores válidos: true: Suspensa. false: Não suspensa.	true
SourceType	string	Não	O tipo de origem de dados. Valores válidos: UDM_ECS: Backup de instância ECS. OSS: Backup de OSS. NAS: Backup de NAS do Alibaba Cloud. COMMON_NAS: Backup de NAS local. ECS_FILE: ECS File Backup Standard Edition. File: Backup de arquivos locais. COMMON_FILE_SYSTEM: Backup de CPFS baseado em agente. OTS: Backup do Tablestore. CPFS: Backup de CPFS sem agente.	UDM_ECS
Source	string	Não	O caminho de origem. O significado varia com base no valor de SourceType: OSS: o prefixo para backup. Se você não especificar este parâmetro, o diretório raiz de todo o bucket será incluído no backup. Apenas um único prefixo é suportado. Para fazer backup de objetos cujos nomes começam com o prefixo `data`, insira `data` em vez de `/data`. ECS_FILE: os diretórios para backup. Se você não especificar este parâmetro, todos os diretórios serão incluídos no backup. Você pode especificar vários diretórios ao mesmo tempo. Para fazer backup de arquivos nos diretórios `/a` e `/b`, insira `["/a", "/b"]`. File: os diretórios para backup. Se você não especificar este parâmetro, todos os diretórios serão incluídos no backup. Você pode especificar vários diretórios ao mesmo tempo. Para fazer backup de arquivos nos diretórios `/a` e `/b`, insira `["/a", "/b"]`. COMMON_FILE_SYSTEM: obrigatório. Os caminhos para backup. Você pode especificar vários caminhos ao mesmo tempo. Para fazer backup dos caminhos `/a` e `/b`, insira `["/a", "/b"]`. Para fazer backup do caminho raiz, insira `["/"]`. COMMON_NAS: obrigatório. O caminho para backup. Apenas um único caminho é suportado. Para fazer backup do caminho `/a`, insira `["/a"]`. Para fazer backup do caminho raiz, insira `["/"]`. OTS: a lista de tabelas para backup. Se você não especificar este parâmetro, todas as tabelas serão incluídas no backup. Você pode especificar várias tabelas ao mesmo tempo. Para fazer backup da Tabela `a` e da Tabela `b`, insira `["a", "b"]`. CPFS: obrigatório. Os caminhos para backup. Você pode especificar vários caminhos ao mesmo tempo. Para fazer backup dos caminhos `/a` e `/b`, insira `["/a", "/b"]`. Para fazer backup do caminho raiz, insira `["/"]`.	/src
Include	string	Não	Os tipos de arquivo a serem incluídos no backup. Este parâmetro está disponível quando SourceType é definido como ECS_FILE, File, NAS, COMMON_NAS, COMMON_FILE_SYSTEM ou CPFS. O backup de todos os arquivos dos tipos especificados é realizado. O valor pode ter até 255 caracteres.	[\".doc\",\".xltm\"]
Exclude	string	Não	Os tipos de arquivo a serem excluídos do backup. Este parâmetro está disponível quando SourceType é definido como ECS_FILE, File, NAS, COMMON_NAS, COMMON_FILE_SYSTEM ou CPFS. Nenhum arquivo dos tipos especificados é incluído no backup. O valor pode ter até 255 caracteres.	[\".doc\",\".xltm\"]
SpeedLimit	string	Não	O limitador de tráfego de backup. Este parâmetro é obrigatório quando SourceType é definido como ECS_FILE ou File. O formato é `{start}{end}{bandwidth}`. Várias configurações de limitação devem ser separadas e seus períodos de tempo não podem se sobrepor. start: a hora de início. end: a hora de término. bandwidth: o limite de largura de banda, em KB/s.	0:24:1024
AdvancedOptions	object	Não	As opções avançadas.
UdmDetail	object	Não	As opções avançadas para backup de instância ECS.
ExcludeDiskIdList	array	Não	Os IDs dos discos em nuvem que não precisam ser protegidos. Este parâmetro é ignorado se DiskIdList não estiver vazio.
	string	Não	O ID do disco em nuvem que não precisa ser protegido.	d-bp1************apo
DiskIdList	array	Não	Os IDs dos discos em nuvem a serem protegidos. Este valor fica vazio quando todos os discos em nuvem estão protegidos.
	string	Não	O ID do disco em nuvem a ser protegido.	d-bp1************apo
SnapshotGroup	boolean	Não	Especifica se um grupo de consistência de snapshot deve ser criado. Um grupo de consistência de snapshot pode ser criado apenas quando todos os discos em nuvem são ESSDs.	true
AppConsistent	boolean	Não	Especifica se a consistência de aplicativo deve ser ativada. Snapshots consistentes com o aplicativo podem ser criados apenas quando todos os discos em nuvem são ESSDs.	false
RamRoleName	string	Não	O nome da função RAM configurada para criar snapshots consistentes com o aplicativo. Este parâmetro é obrigatório quando AppConsistent é definido como true.	AliyunECSInstanceForHbrRole
PreScriptPath	string	Não	O caminho do script de pré-congelamento a ser executado antes da criação de um snapshot consistente com o aplicativo. Este parâmetro é obrigatório quando AppConsistent é definido como true.	/tmp/prescript.sh
PostScriptPath	string	Não	O caminho do script de pós-descongelamento a ser executado após a criação de um snapshot consistente com o aplicativo. Este parâmetro é obrigatório quando AppConsistent é definido como true.	/tmp/postscript.sh
EnableFsFreeze	boolean	Não	Este parâmetro é obrigatório apenas quando AppConsistent é definido como true. Especifica se o mecanismo FsFreeze do Linux deve ser usado para garantir a consistência de somente leitura do sistema de arquivos antes da criação de um snapshot consistente com o aplicativo. Valor padrão: true.	true
TimeoutInSeconds	integer	Não	O tempo limite de congelamento de E/S, em segundos. Este parâmetro é obrigatório quando AppConsistent é definido como true. Valor padrão: 30.	30
EnableWriters	boolean	Não	Especifica se snapshots consistentes com o aplicativo devem ser configurados. Este parâmetro é obrigatório quando AppConsistent é definido como true. Valores válidos: true: cria snapshots consistentes com o aplicativo. false: cria snapshots consistentes com o sistema de arquivos. Valor padrão: true.	true
OssDetail	object	Não	As opções avançadas para backup de OSS.
InventoryId	string	Não	O nome do inventário do OSS. Se este valor não estiver vazio, o inventário do OSS será usado para ajuste de desempenho. Recomendamos o uso de um inventário para melhorar o desempenho do backup incremental ao fazer backup de mais de 100 milhões de objetos do OSS. As taxas de armazenamento geradas pelos arquivos de inventário são cobradas separadamente pelo OSS. A geração de arquivos de inventário do OSS leva tempo. Os backups podem falhar antes que os arquivos de inventário sejam gerados. Você pode aguardar o próximo ciclo para executar o backup.	oss-inventory-default
InventoryCleanupPolicy	string	Não	Especifica se os arquivos de inventário devem ser excluídos após o backup. Este parâmetro é válido apenas quando um inventário do OSS é usado. Valores válidos: NO_CLEANUP: não exclui os arquivos. DELETE_CURRENT: exclui o arquivo atual. DELETE_CURRENT_AND_PREVIOUS: exclui todos os arquivos.	NO_CLEANUP
IgnoreArchiveObject	boolean	Não	Especifica se os objetos de arquivamento devem ser ignorados nas estatísticas da tarefa e nas listas de arquivos com falha.	true
FileDetail	object	Não	As opções avançadas para backup de arquivos.
UseVSS	boolean	Não	Especifica se o recurso Volume Shadow Copy Service (VSS) para Windows deve ser ativado. Valores válidos: true: ativa o recurso. false: desativa o recurso.	true
AdvPolicy	boolean	Não	Especifica se a política avançada deve ser usada. Valores válidos: true: usa a política avançada. false: não usa a política avançada.	true
CommonNasDetail	object	Não	As opções avançadas para backup de NAS local.
FullOnIncrementFail	boolean	Não	Especifica se deve alternar para um backup completo quando um backup incremental falhar. Valores válidos: true: alterna para um backup completo em caso de falha. false: não alterna para um backup completo em caso de falha.	true
FetchSliceSize	integer	Não	O tamanho da fatia da subtarefa, medido pelo número de arquivos.	100000
ClusterId	string	Não	O ID do grupo de clientes de backup. Para backup de NAS local, um cliente é selecionado no grupo de clientes de backup para realizar o backup.	cl-000**************ggu
CommonFileSystemDetail	object	Não	As opções avançadas para backup de CPFS.
FullOnIncrementFail	boolean	Não	Especifica se deve alternar para um backup completo quando um backup incremental falhar. Valores válidos: true: alterna para um backup completo em caso de falha. false: não alterna para um backup completo em caso de falha.	true
FetchSliceSize	integer	Não	O tamanho da fatia da subtarefa, medido pelo número de arquivos.	100000
CrossAccountType	string	Não	O tipo de backup entre contas. Valor padrão: SELF_ACCOUNT. Valores válidos: SELF_ACCOUNT: faz backup de dados na conta atual. CROSS_ACCOUNT: faz backup de dados entre contas.	SELF_ACCOUNT
CrossAccountUserId	integer	Não	O UID do Alibaba Cloud da conta de origem usada para backup entre contas.	144**********732
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backup entre contas.	hbrcrossrole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Code	string	O código de retorno. Um valor 200 indica sucesso.	200
Message	string	A mensagem de retorno. O valor successful indica sucesso, e uma mensagem de erro é retornada quando ocorre um erro.	successful
RequestId	string	O ID da solicitação.	82CC5B6C-72F7-5D39-92F6-67887DF9AD46

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "82CC5B6C-72F7-5D39-92F6-67887DF9AD46"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PolicyAlreadyBoundWithThisDataSource	This datasource has already been bound with the policy, please use another one.	A fonte de dados já está vinculada a esta política. Tente vincular uma nova política.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.