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

Consulta a lista de clusters Agentic Database.

Descrição da operação

Esta operação suporta filtragem e retorno da lista de operadores de modelo relacionados com base nos parâmetros RelativeDBClusterId e KubeType.
Nota: Certifique-se de que o RelativeDBClusterId fornecido na solicitação corresponda a um ID de instância de banco de dados PolarDB existente. Caso contrário, os dados não poderão ser recuperados corretamente.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
DBClusterIds	string	Não	O ID do cluster. Separe múltiplos IDs de cluster com vírgulas (,).	pc-**************
AgenticDbClusterIds	string	Não	O ID do cluster Agentic. Separe múltiplos IDs de cluster com vírgulas (,).	pagc-**************
DBClusterDescription	string	Não	A descrição do cluster. Correspondência aproximada é suportada.	pc-****************
DBClusterStatus	string	Não	O status do cluster.	Running
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30, 50 e 100. Valor padrão: 30.	30
PageNumber	integer	Não	O número da página.	1
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************
Tag	array<object>	Não	As tags.
	object	Não	As tags.
Value	string	Não	O valor da tag que corresponde à chave da tag.	testValueData
Key	string	Não	A chave da tag. Você pode filtrar a lista de clusters por tag. Você pode especificar até 20 pares de tags. O número n de cada par de tags deve ser único e deve ser um inteiro consecutivo começando em 1. O valor de Tag.n.Key corresponde a Tag.n.Value.	type
MaxResults	integer	Não	O número máximo de entradas a serem retornadas. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior. Se não houver próxima consulta, não passe este parâmetro.	212db86sca4384811e0b5e8707e******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
TotalRecordCount	integer	O número total de registros.	1
PageRecordCount	integer	O número de clusters na página atual.	1
RequestId	string	O ID da solicitação.	CDB3258F-B5DE-43C4-8935-CBA0CA******
PageNumber	integer	O número da página.	1
Items	array<object>	A lista de clusters.
	array<object>	As informações de conexão SSL.
DBClusterId	string	O ID do cluster.	pc-xxxxxx
RegionId	string	O ID da região.	cn-hangzhou
ZoneId	string	O ID da zona.	cn-hangzhou-i
DBClusterStatus	string	O status do cluster.	Running
CreateTime	string	A hora em que o cluster foi criado.	2020-08-14T05:58:42Z
DBClusterDescription	string	A descrição do cluster.	ocpx
DBType	string	O tipo de mecanismo de banco de dados.	MySQL
DBVersion	string	A versão do mecanismo de banco de dados.	8.0
Category	string	A edição do cluster. Valores válidos: Normal: Edição Cluster Basic: Edição Nó Único Archive: Edição X-Engine NormalMultimaster: Multi-master Cluster (Banco de Dados/Tabela)	Normal
ServerlessType	string	O tipo serverless. O valor AgileServerless indica que o cluster é um cluster serverless.	AgileServerless
PayType	string	O método de cobrança. Valores válidos: Postpaid: pós-pago. Prepaid: assinatura.	Postpaid
StorageType	string	O tipo de armazenamento. Valores válidos: essdpl0 essdpl1 essdpl2 essdpl3	city_redundancy
StorageUsed	integer	O uso de armazenamento do cluster. Unidade: bytes.	3009413120
ScaleMin	string	O valor mínimo: 0 a 32 PCUs. O valor mínimo deve ser menor ou igual ao valor máximo. Unidade: PCU.	1
ScaleMax	string	O valor máximo: 1 a 32 PCUs. Unidade: PCU.	9
VpcId	string	O ID da virtual private cloud (VPC) na qual o endpoint reside.	vpc-****************
VswitchId	string	O ID do vSwitch.	vsw-**************
Expired	string	Indica se o cluster expirou. Valores válidos: true false Nota Este parâmetro é retornado apenas para clusters cujo método de cobrança é Prepaid (assinatura).	false
LockMode	string	O status de bloqueio do cluster. Valores válidos: Unlock: Normal. ManualLock: Bloqueado manualmente. LockByExpiration: Bloqueado automaticamente devido à expiração do cluster.	Unlock
ExpireTime	string	A hora de expiração do cluster. Nota Um valor específico é retornado apenas para clusters cujo método de cobrança é Prepaid (assinatura). Um valor vazio é retornado para clusters Postpaid (pós-pago).	2025-06-25T09:37:10Z
Tags	array<object>	A chave da tag. Você pode filtrar a lista de clusters por tag. Você pode especificar até 20 pares de tags. O número n de cada par de tags deve ser único e deve ser um inteiro consecutivo começando em 1. O valor de Tag.n.Key corresponde a Tag.n.Value.
	object	A chave da tag. Você pode filtrar a lista de clusters por tag. Você pode especificar até 20 pares de tags. O número n de cada par de tags deve ser único e deve ser um inteiro consecutivo começando em 1. O valor de Tag.n.Key corresponde a Tag.n.Value.
Value	string		testValueData
Key	string		MySQL
AgenticDbClusterId	string	O ID do cluster Agentic.	pagc-**************
AgenticDbClusterDescription	string	A descrição do cluster Agentic.	pagc-**************
NextToken	string	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior. Se não houver próxima consulta, não passe este parâmetro.	212db86sca4384811e0b5e8707e******
MaxResults	integer	O número máximo de entradas a serem retornadas. Valor padrão: 10.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "PageNumber": 1,
  "Items": [
    {
      "DBClusterId": "pc-xxxxxx",
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-i",
      "DBClusterStatus": "Running",
      "CreateTime": "2020-08-14T05:58:42Z",
      "DBClusterDescription": "ocpx",
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "Category": "Normal",
      "ServerlessType": "AgileServerless",
      "PayType": "Postpaid",
      "StorageType": "city_redundancy",
      "StorageUsed": 3009413120,
      "ScaleMin": "1",
      "ScaleMax": "9",
      "VpcId": "vpc-****************",
      "VswitchId": "vsw-**************",
      "Expired": "false",
      "LockMode": "Unlock",
      "ExpireTime": "2025-06-25T09:37:10Z",
      "Tags": [
        {
          "Value": "testValueData",
          "Key": "MySQL"
        }
      ],
      "AgenticDbClusterId": "pagc-**************",
      "AgenticDbClusterDescription": "pagc-**************"
    }
  ],
  "NextToken": "212db86sca4384811e0b5e8707e******",
  "MaxResults": 10
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.