Consultar instâncias do ApsaraDB RDS com backup entre regiões ativado - : Central de Documentação do Alibaba Cloud

Antes de chamar esta operação, certifique-se de que a instância execute uma das seguintes versões de mecanismo de banco de dados e edições do RDS:

MySQL 8.0 na edição de alta disponibilidade (com SSDs locais)
MySQL 5.7 na edição de alta disponibilidade (com SSDs locais)
MySQL 5.6

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Yes	DescribeCrossRegionBackupDBInstance	A operação que você deseja executar. Defina o valor como DescribeCrossRegionBackupDBInstance.
RegionId	String	Yes	cn-hangzhou	O ID da região.
DBInstanceId	String	No	rm-uf6wjk5xxxxxxxxxx	O ID da instância. São permitidos até 30 IDs de instância em uma única solicitação. Se você inserir mais de um ID de instância, separe-os com vírgulas (,).
PageSize	Integer	No	30	O número de entradas a serem retornadas em cada página. Valor padrão: 30
PageNumber	Integer	No	1	O número da página a ser retornada. Valores válidos: um inteiro positivo diferente de zero. Valor padrão: 1.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RegionId	String	cn-hangzhou	O ID da região.
TotalRecords	Integer	100	O número total de entradas retornadas.
ItemsNumbers	Integer	1	O número total de itens retornados para as configurações de backup entre regiões.
PageNumber	Integer	1	O número da página retornada. Valores válidos: um inteiro positivo diferente de zero. Valor padrão: 1.
PageSize	Integer	30	O número de entradas retornadas por página. Valor padrão: 30.
RequestId	String	33517002-182D-40BE-93EC-610BD3381045	O ID da solicitação.
Items	Array		Um array que consiste em instâncias e suas configurações de backup entre regiões.
Item
BackupEnabled	String	Enable	O status do comutador geral de backup entre regiões na instância. Valores válidos: Disable Enable
BackupEnabledTime	String	2019-06-12T05:44:21Z	O horário em que o backup de dados entre regiões foi ativado na instância. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
CrossBackupRegion	String	cn-shanghai	O ID da região de destino onde os backups entre regiões da instância são armazenados.
CrossBackupType	String	1	A política usada para salvar os backups entre regiões da instância. Valor padrão: 1. O valor padrão 1 indica que todos os backups entre regiões são salvos.
DBInstanceDescription	String	Test database	O nome da instância. O nome tem de 2 a 256 caracteres. Pode conter letras, dígitos, sublinhados (_) e hifens (-) e deve começar com uma letra. Nota O nome da instância não pode começar com http:// ou https://.
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	O ID da instância.
DBInstanceStatus	String	Running	O status da instância. Para mais informações, consulte tabela de status da instância.
Engine	String	MySQL	O mecanismo de banco de dados.
EngineVersion	String	5.6	A versão do mecanismo de banco de dados.
LockMode	String	Unlock	O status de bloqueio da instância. Valores válidos: Unlock: A instância não está bloqueada. ManualLock: A instância está bloqueada manualmente. LockByExpiration: A instância é bloqueada automaticamente ao expirar. LockByRestoration: A instância é bloqueada automaticamente antes de uma restauração. LockByDiskQuota: A instância é bloqueada automaticamente porque o espaço de armazenamento está esgotado. Nessa situação, a instância fica inacessível.
LogBackupEnabled	String	Enable	O status do comutador de backup de log entre regiões na instância. Valores válidos: Disable Enable
LogBackupEnabledTime	String	2019-06-12T05:44:21Z	O horário em que o backup de log entre regiões foi ativado na instância. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
RetentType	Integer	1	A política usada para reter os backups entre regiões da instância. Os backups entre regiões só podem ser retidos com base no período de retenção especificado. Valor padrão: 1.
Retention	Integer	15	O número de dias pelos quais os backups entre regiões da instância são retidos. Valores válidos: 7 to 1825.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/? Action=DescribeCrossRegionBackupDBInstance
&RegionId=cn-hangzhou
&<Common request parameters>

Respostas de exemplo de sucesso

Formato XML

<DescribeCrossRegionBackupDBInstanceResponse>
  <Items>
		    <Item>
			      <LockMode>Unlock</LockMode>
			      <CrossBackupType>1</CrossBackupType>
			      <LogBackupEnabled>Enable</LogBackupEnabled>
			      <BackupEnabledTime>2019-06-12T05:44:21Z</BackupEnabledTime>
			      <BackupEnabled>Enable</BackupEnabled>
			      <RetentType>1</RetentType>
			      <DBInstanceId>rm-bpxxxxx</DBInstanceId>
			      <Retention>15</Retention>
			      <DBInstanceDescription>Test database</DBInstanceDescription>
			      <Engine>MySQL</Engine>
			      <LogBackupEnabledTime>2019-06-12T05:44:21Z</LogBackupEnabledTime>
			      <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
			      <EngineVersion>5.6</EngineVersion>
			      <DBInstanceStatus>Running</DBInstanceStatus>
		    </Item>
	  </Items>
	  <PageNumber>1</PageNumber>
	  <RegionId>cn-hangzhou</RegionId>
	  <RequestId>33517002-182D-40BE-93EC-610BD3381045</RequestId>
	  <ItemsNumbers>1</ItemsNumbers>
	  <TotalRecords>1</TotalRecords>
</DescribeCrossRegionBackupDBInstanceResponse>

Formato JSON

{
    "Items": {
        "Item": [
            {
                "LockMode": "Unlock",
                "CrossBackupType": "1",
                "LogBackupEnabled": "Enable",
                "BackupEnabledTime": "2019-06-12T05:44:21Z",
                "BackupEnabled": "Enable",
                "RetentType": 1,
                "DBInstanceId": "rm-bpxxxxx",
                "Retention": 15,
                "DBInstanceDescription": "Test database",
                "Engine": "MySQL",
                "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
                "CrossBackupRegion": "cn-shanghai",
                "EngineVersion": "5.6",
                "DBInstanceStatus": "Running"
            }
        ]
    },
    "PageNumber": 1,
    "RegionId": "cn-hangzhou",
    "RequestId": "33517002-182D-40BE-93EC-610BD3381045",
    "ItemsNumbers": 1,
    "TotalRecords": 1
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	A mensagem de erro retornada porque o mecanismo de banco de dados da instância não suporta esta operação.

Para ver a lista de códigos de erro, acesse a Central de Erros de API.