DescribeDBClusterMigration - PolarDB: Central de Documentação do Alibaba Cloud

Consulta o status de migração de um cluster PolarDB.

Descrição da operação

Você pode usar esta operação para consultar o status de uma migração com um clique de uma instância ApsaraDB RDS for MySQL para um cluster PolarDB for MySQL. Para obter mais informações, consulte Atualizar uma instância ApsaraDB RDS for MySQL para o PolarDB for MySQL.
Antes de chamar esta operação, você deve criar uma tarefa de atualização com um clique para o cluster chamando a operação CreateDBCluster e definindo o parâmetro CreationOption como MigrationFromRDS.

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

polardb:DescribeDBClusterMigration

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-**************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DBClusterEndpointList	array<object>	Os detalhes dos endpoints do PolarDB.
	array<object>
AddressItems	array<object>	Os detalhes das strings de conexão.
	object
VSwitchId	string	The ID of the virtual switch.	vsw-**********
ConnectionString	string	The connection string.	pc-**************.rwlb.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public: An endpoint for the Internet. Private: A private endpoint. Inner: A private endpoint in a classic network.	Private
Port	string	The port.	3306
VPCId	string	The ID of the virtual private cloud (VPC).	vpc-**********
IPAddress	string	The IP address.	192.*.*.10
SSLEnabled	string	Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values: Enabled: SSL encryption is enabled. Disabled: SSL encryption is disabled.	Enabled
DBEndpointId	string	O ID do endpoint.	pe-***********
EndpointType	string	O tipo do endpoint. Valores válidos: Cluster: O endpoint padrão do cluster. Primary: O endpoint primário. Custom: Um endpoint personalizado do cluster.	Cluster
ReadWriteMode	string	O modo de leitura/gravação. Valores válidos: ReadWrite: Leitura e gravação (divisão automática de leitura/gravação). ReadOnly (Default): Somente leitura.	ReadOnly
Comment	string	Os comentários sobre a exceção de migração. Se nenhuma exceção ocorrer durante a migração, um valor vazio será retornado.	test
RequestId	string	O ID da solicitação.	F2A9EFA7-915F-4572-8299-85A307******
ExpiredTime	string	A hora em que a relação de replicação entre a instância ApsaraDB RDS e o cluster PolarDB expira. A hora está no formato `YYYY-MM-DDThh:mm:ssZ` e é exibida em UTC.	2020-06-17T01:56:36Z
DBClusterId	string	O ID do cluster.	pc-****************
Topologies	string	A relação de sincronização de dados. Valores válidos: RDS2POLARDB: Os dados são sincronizados da instância ApsaraDB RDS para o cluster PolarDB. POLARDB2RDS: Os dados são sincronizados do cluster PolarDB para a instância ApsaraDB RDS.	RDS2POLARDB
RdsReadWriteMode	string	O modo de leitura/gravação da instância ApsaraDB RDS de origem. Valores válidos: rw: Leitura e gravação. ro: Somente leitura.	rw
SourceRDSDBInstanceId	string	O ID da instância ApsaraDB RDS de origem.	rm-************
DBClusterReadWriteMode	string	O modo de leitura/gravação do cluster. Valores válidos: rw: Leitura e gravação. ro: Somente leitura.	ro
DelayedSeconds	integer	O atraso de replicação entre a instância ApsaraDB RDS e o cluster PolarDB, em segundos.	0
MigrationStatus	string	O status de migração do cluster PolarDB. Valores válidos: NO_MIGRATION: Nenhuma tarefa de migração foi criada. RDS2POLARDB_CLONING: Os dados estão sendo clonados. RDS2POLARDB_SYNCING: Os dados estão sendo sincronizados. Neste estado, o cluster PolarDB é somente leitura e a instância ApsaraDB RDS é de leitura e gravação. SWITCHING: O banco de dados está sendo alternado. POLARDB2RDS_SYNCING: A alternância do banco de dados foi concluída. Neste estado, o cluster PolarDB é de leitura e gravação e a instância ApsaraDB RDS é somente leitura. Altere os endpoints em sua aplicação. ROLLBACK: A migração está sendo revertida. Após a conclusão da reversão, o status da migração muda para RDS2POLARDB_SYNCING. CLOSING_MIGRATION: A tarefa de migração está sendo encerrada.	RDS2POLARDB_SYNCING
DtsInstanceId	string	O ID da tarefa de sincronização.	dts**********618bs
RdsEndpointList	array<object>	Os detalhes dos endpoints do ApsaraDB RDS.
	array<object>
AddressItems	array<object>	Os detalhes das strings de conexão.
	object
VSwitchId	string	The ID of the vSwitch.	vsw-**************
ConnectionString	string	The connection string.	rm-***********.mysql.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public: An endpoint for the Internet. Private: A private endpoint. Inner: A private endpoint in a classic network.	Private
Port	string	The port.	3306
VPCId	string	The ID of the VPC.	vpc-************
IPAddress	string	The IP address.	172.*.*.173
SSLEnabled	string	Indicates whether SSL encryption is enabled. Valid values: Enabled: SSL encryption is enabled. Disabled: SSL encryption is disabled.	Enabled
DBEndpointId	string	O ID do endpoint.	rm-************-normal
EndpointType	string	O tipo do endpoint. Valores válidos: Normal: Um endpoint comum. ReadWriteSplitting: Um endpoint de divisão de leitura/gravação.	Normal
CustinsType	string	O tipo de instância.	ReadOnly Maxscale Primary
SrcDbType	string	O tipo do banco de dados de origem. Valores válidos: PolarDBMySQL: O banco de dados de origem para uma atualização de versão principal de um cluster PolarDB. RDS: O banco de dados de origem para migrar dados de uma instância ApsaraDB RDS para um cluster PolarDB for MySQL.	PolarDBMySQL

Exemplos

Resposta de sucesso

JSON formato

{
  "DBClusterEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**********",
          "ConnectionString": "pc-**************.rwlb.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-**********",
          "IPAddress": "192.***.***.10",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "pe-***********",
      "EndpointType": "Cluster",
      "ReadWriteMode": "ReadOnly"
    }
  ],
  "Comment": "test",
  "RequestId": "F2A9EFA7-915F-4572-8299-85A307******",
  "ExpiredTime": "2020-06-17T01:56:36Z",
  "DBClusterId": "pc-****************",
  "Topologies": "RDS2POLARDB",
  "RdsReadWriteMode": "rw",
  "SourceRDSDBInstanceId": "rm-************",
  "DBClusterReadWriteMode": "ro",
  "DelayedSeconds": 0,
  "MigrationStatus": "RDS2POLARDB_SYNCING",
  "DtsInstanceId": "dts**********618bs",
  "RdsEndpointList": [
    {
      "AddressItems": [
        {
          "VSwitchId": "vsw-**************",
          "ConnectionString": "rm-***********.mysql.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "3306",
          "VPCId": "vpc-************",
          "IPAddress": "172.***.***.173",
          "SSLEnabled": "Enabled"
        }
      ],
      "DBEndpointId": "rm-************-normal",
      "EndpointType": "Normal",
      "CustinsType": "ReadOnly\nMaxscale\nPrimary"
    }
  ],
  "SrcDbType": "PolarDBMySQL"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.