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

Consulta a lista de recursos protegidos.

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

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NextToken	string	Não	O token de paginação para a próxima página. Se NextToken estiver vazio, não existe próxima página.	aWQj********MCMy
MaxResults	integer	Não	O número máximo de resultados a serem retornados por consulta. Valores válidos: 10 a 100. Valor padrão: 10.	10
CreatedByProduct	string	Não	A capacidade do produto à qual o recurso pertence. Valores válidos: HBR: Capacidades padrão do Cloud Backup. BASIC: ECS File Backup Essential Edition.	BASIC
SourceType	string	Não	O tipo de recurso de backup. Valores válidos: ECS_FILE: Backup de arquivos ECS. COMMON_FILE_SYSTEM: Backup de CPFS. COMMON_NAS: Backup de NAS local. File: Backup de arquivos locais. NAS: Backup do Alibaba Cloud NAS. OSS: Backup do OSS. Valores válidos: NAS : NAS. COMMON_FILE_SYSTEM : COMMON_FILE_SYSTEM. ECS_FILE : ECS_FILE. COMMON_NAS : COMMON_NAS. File : File. OSS : OSS.	ECS_FILE
ResourceId	string	Não	O ID do recurso. O significado deste parâmetro varia de acordo com o valor de SourceType: SourceType=ECS_FILE: o ID da instância ECS. SourceType=COMMON_FILE_SYSTEM: o ID da origem de dados do CPFS. SourceType=COMMON_NAS: o ID da origem de dados do NAS local. SourceType=File: o ID do cliente do servidor local. SourceType=NAS: o ID do sistema de arquivos do Alibaba Cloud NAS. SourceType=OSS: o bucket do OSS.	i-wz95************7zrd
Skip	integer	Não	O número de entradas a serem ignoradas para uma consulta paginada. Se o número de entradas ignoradas exceder o número total de entradas correspondentes, uma lista vazia será retornada. O número de entradas ignoradas deve ser um múltiplo de MaxResults.	10
HasSnapshot	boolean	Não	Especifica se existem pontos de backup.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Code	string	O código de retorno. Um valor 200 indica sucesso.	200
MaxResults	integer	O número máximo de resultados a serem retornados por consulta. Valores válidos: 10 a 100. Valor padrão: 10.	10
Message	string	A mensagem de retorno. Um valor successful indica sucesso. Se ocorrer um erro, a mensagem de erro correspondente será retornada.	successful
NextToken	string	O token de paginação para a próxima página. Se NextToken estiver vazio, não existe próxima página.	eyJJ************MX0=
ProtectedResources	array<object>	A lista de recursos protegidos.
	object	O recurso protegido.
BackupPlanCount	integer	O número de planos de backup.	1
CreatedByProduct	string	A capacidade do produto à qual o recurso pertence. Valores válidos: HBR: Capacidades padrão do Cloud Backup. BASIC: ECS File Backup Essential Edition.	BASIC
ProtectedDataSize	integer	O volume de dados protegidos, em bytes. Este parâmetro é compatível apenas com o ECS File Backup Essential Edition. SourceType=ECS_FILE: a capacidade de armazenamento do armazenamento em bloco com backup.	107374182400
ProtectedResourceId	string	O ID do recurso protegido.	pr-0004************gs61
ResourceId	string	O ID do recurso. O significado deste parâmetro varia de acordo com o valor de SourceType: SourceType=ECS_FILE: o ID da instância ECS. SourceType=COMMON_FILE_SYSTEM: o ID da origem de dados do CPFS. SourceType=COMMON_NAS: o ID da origem de dados do NAS local. SourceType=File: o ID do cliente do servidor local. SourceType=NAS: o ID do sistema de arquivos do Alibaba Cloud NAS. SourceType=OSS: o bucket do OSS.	i-wz95************7zrd
ResourceOwnerId	integer	O UID do usuário ao qual o recurso pertence.	1024********0703
ResourceRegionId	string	O ID da região à qual o recurso pertence.	cn-hangzhou
SnapshotCount	integer	O número de snapshots de backup.	30
SourceType	string	O tipo de recurso de backup. Valores válidos: ECS_FILE: Backup de arquivos ECS. COMMON_FILE_SYSTEM: Backup de CPFS. COMMON_NAS: Backup de NAS local. File: Backup de arquivos locais. NAS: Backup do Alibaba Cloud NAS. OSS: Backup do OSS.	ECS_FILE
RequestId	string	O ID da solicitação.	EB09**----******6C38
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
TotalCount	integer	O número total de recursos protegidos.	3

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "MaxResults": 10,
  "Message": "successful",
  "NextToken": "eyJJ************MX0=",
  "ProtectedResources": [
    {
      "BackupPlanCount": 1,
      "CreatedByProduct": "BASIC",
      "ProtectedDataSize": 107374182400,
      "ProtectedResourceId": "pr-0004************gs61",
      "ResourceId": "i-wz95************7zrd",
      "ResourceOwnerId": 0,
      "ResourceRegionId": "cn-hangzhou",
      "SnapshotCount": 30,
      "SourceType": "ECS_FILE"
    }
  ],
  "RequestId": "EB09****-****-****-****-********6C38",
  "Success": true,
  "TotalCount": 3
}

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.