DescribeBackupStorage - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Descrição da operação

O uso de backup de um cluster fragmentado é cobrado por fragmento. Você pode usar esta operação para consultar o uso de backup de um único fragmento.

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

dds:DescribeBackupStorage

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região onde a instância está localizada. Chame a operação DescribeDBInstanceAttribute para consultar o ID da região.	cn-bejing
DBInstanceId	string	Sim	O ID da instância.	dds-2zeb2d64cb46xxxx
NodeId	string	Não	O ID do nó de fragmento na instância de cluster fragmentado.\n\n> Este parâmetro é obrigatório se o parâmetro DBInstanceId especificar o ID de uma instância de cluster fragmentado.	d-2zee48956b4axxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	D648B367-15B6-1B42-BD4B-4XXXXXXXXX
FullStorageSize	integer	O espaço de armazenamento usado por backups completos. Unidade: bytes.\n\n> Instâncias que usam discos em nuvem são submetidas a backup usando snapshots. O tamanho de um backup completo é o tamanho total da cadeia de snapshots.	789221621
LogStorageSize	integer	O espaço de armazenamento usado por backups de log. Unidade: bytes.	7892216
FreeSize	integer	A cota de backup gratuita para a instância. Unidade: bytes.	42949672960

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D648B367-15B6-1B42-BD4B-4XXXXXXXXX",
  "FullStorageSize": 789221621,
  "LogStorageSize": 7892216,
  "FreeSize": 42949672960
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBInstance.Malformed	Too many instance ids or instance id format is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.