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

Consulta clusters PolarDB em uma região que possuem conjuntos de backup.

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

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************
RegionId	string	Sim	O ID da região. Nota Chame a operação DescribeRegions para visualizar detalhes sobre regiões.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Você pode especificar múltiplos IDs de cluster. Separe os IDs com uma vírgula (,).	pc-**************
DBClusterDescription	string	Não	O nome do cluster. O nome do cluster deve atender aos seguintes requisitos: Não pode começar com `http://` ou `https://`. Deve ter de 2 a 256 caracteres de comprimento.	test
DBType	string	Não	O tipo de mecanismo de banco de dados. Valores válidos: MySQL PostgreSQL Oracle	MySQL
IsDeleted	integer	Não	Especifica se o cluster foi excluído. Valores válidos: 0: O cluster não foi excluído. 1: O cluster foi excluído.	0
PageSize	integer	Não	O número de registros em cada página. Valores válidos: 30 50 100 Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser um inteiro maior que 0 e não deve exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
DBVersion	string	Não	A versão do mecanismo de banco de dados. Valores válidos para MySQL: 5.6 5.7 8.0 Valores válidos para PostgreSQL: 11 14 Valores válidos para Oracle: 11 14	8.0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	F8529AA2-522F-4B30-B80B-8F7D39******
PageNumber	integer	O número da página.	1
PageRecordCount	integer	O número de clusters na página atual.	1
TotalRecordCount	integer	O número total de entradas retornadas.	1
Items	object
DBCluster	array<object>	Os detalhes do cluster.
	object
DeletedTime	string	The time when the cluster was deleted.	2022-05-12T03:25:37Z
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-******************
ExpireTime	string	The expiration time. Nota This parameter is returned only for subscription clusters. An empty string is returned for pay-as-you-go clusters.	2022-09-14T16:00:00Z
Expired	string	Indicates whether the cluster has expired. Nota This parameter is returned only for subscription clusters.	false
CreateTime	string	The time when the cluster was created.	2022-05-09T09:33:51Z
DBNodeClass	string	The node specifications.	polar.mysql.x4.medium
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DBType	string	The type of the database engine.	MySQL
LockMode	string	The lock state of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked due to expiration.	Unlock
RegionId	string	The region ID.	cn-hangzhou
DeletionLock	integer	The deletion lock status of the cluster. Valid values: 0: The cluster is not locked and can be deleted. 1: The cluster is locked and cannot be deleted.	0
DBVersion	string	The version of the database engine.	8.0
DBClusterId	string	The cluster ID.	pc-****************
DBClusterStatus	string	The cluster status. Valid values: Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being released. Rebooting: The cluster is restarting. DBNodeCreating: Nodes are being added. DBNodeDeleting: Nodes are being deleted. ClassChanging: The node specifications are being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified. Deleted: The cluster is released.	Running
IsDeleted	integer	Indicates whether the cluster is released. Valid values: 1: The cluster is released. 0: The cluster is not released.	1
DBClusterNetworkType	string	The network type of the cluster.	VPC
DBClusterDescription	string	The cluster name.	test
ZoneId	string	The zone ID.	cn-hangzhou-h
Engine	string	The cluster engine.	POLARDB

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "DBCluster": [
      {
        "DeletedTime": "2022-05-12T03:25:37Z",
        "VpcId": "vpc-******************",
        "ExpireTime": "2022-09-14T16:00:00Z",
        "Expired": "false",
        "CreateTime": "2022-05-09T09:33:51Z",
        "DBNodeClass": "polar.mysql.x4.medium",
        "PayType": "Postpaid",
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "8.0",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "IsDeleted": 1,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "POLARDB"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The request failed to be processed because unknown errors, exceptions, or failures have occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A temporary server error occurred.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.