DescribeBackupGatewayList - Data Management: Central de Documentação do Alibaba Cloud

Consulta uma lista de gateways de backup no Database Backup Service (DBS).

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

dbs:DescribeBackupGatewayList

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Region	string	Sim	A região da instância do DBS. Valores válidos: cn-hangzhou: China (Hangzhou) cn-shanghai: China (Xangai) cn-qingdao: China (Qingdao) cn-beijing: China (Pequim) cn-shenzhen: China (Shenzhen) cn-hongkong: China (Hong Kong) ap-southeast-1: Singapura cn-hangzhou-finance: Hangzhou Finance Cloud cn-shanghai-finance: Shanghai Finance Cloud cn-shenzhen-finance: Shenzhen Finance Cloud	cn-hangzhou
Identifier	string	Não	O identificador exclusivo do gateway de backup. Você pode consultar vários gateways separando os identificadores com vírgulas (,).	7213527653217
PageSize	integer	Não	O número de registros em cada página. Valores válidos: 30 50 100 Nota O valor padrão é 30.	30
PageNum	integer	Não	O número da página. O valor deve ser maior ou igual a 0 e não pode exceder o valor máximo de um número inteiro. O valor padrão é 0.	1
ClientToken	string	Não	Um token de cliente usado para garantir a idempotência da solicitação. Isso evita solicitações duplicadas.	ETnLKlblzczshOTUbOCzxxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP.	200
PageNum	integer	O número da página.	1
RequestId	string	O ID da solicitação.	46361705-8531-492F-807E-A97E482DD4A1
ErrCode	string	O código de erro.	Param.NotFound
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrMessage	string	A mensagem de erro.	The specified parameter %s value is not valid.
TotalPages	integer	O número total de páginas.	1
TotalElements	integer	O número total de gateways de backup.	0
PageSize	integer	O número de registros em cada página.	30
Items	object
BackupGateway	array<object>	Os detalhes do gateway de backup.
	object
DisplayName	string	The display name of the backup gateway.	test
BackupGatewayCreateTime	integer	The time when the backup gateway was created. This is a UNIX timestamp in milliseconds. Example: 1554560477000.	1554560477000
BackupGatewayId	string	The ID of the backup gateway.	2321313123
Region	string	The region.	cn-hangzhou
Identifier	string	The unique identifier of the backup gateway.	sgdsajhdgu
SourceEndpointInternetIP	string	The public IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
BackupGatewayStatus	string	The status of the backup gateway. Valid values: ONLINE: The gateway is online. OFFLINE: The gateway is offline. STOPPED: The gateway is stopped. UPGRADING: The gateway is being upgraded.	ONLINE
SourceEndpointIntranetIP	string	The internal IP address of the host where the backup gateway is installed.	XX.XX.XX.XX
LastHeartbeatTime	integer	The time of the last heartbeat. This is a UNIX timestamp in milliseconds. Example: 1554560477000.	1554560477000
SourceEndpointHostname	string	The hostname of the host where the backup gateway is installed.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "46361705-8531-492F-807E-A97E482DD4A1",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "TotalPages": 1,
  "TotalElements": 0,
  "PageSize": 30,
  "Items": {
    "BackupGateway": [
      {
        "DisplayName": "test",
        "BackupGatewayCreateTime": 1554560477000,
        "BackupGatewayId": "2321313123",
        "Region": "cn-hangzhou",
        "Identifier": "sgdsajhdgu",
        "SourceEndpointInternetIP": "XX.XX.XX.XX",
        "BackupGatewayStatus": "ONLINE",
        "SourceEndpointIntranetIP": "XX.XX.XX.XX",
        "LastHeartbeatTime": 1554560477000,
        "SourceEndpointHostname": "test"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Request.Forbidden	Have no Permissions

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.