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

Consulta clusters personalizados.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterIds	string	Não	O ID do cluster. Para especificar vários clusters, separe seus IDs com uma vírgula.	pc-***************
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
DBClusterDescription	string	Não	A descrição do cluster. A pesquisa aproximada é suportada.	pc-****************
DBClusterStatus	string	Não	O status do cluster. Valores válidos: Creating: O cluster está sendo criado. Running: O cluster está em execução. Deleting: O cluster está sendo excluído. Rebooting: O cluster está sendo reiniciado. DBNodeCreating: Um nó está sendo adicionado. DBNodeDeleting: Um nó está sendo excluído. ClassChanging: As especificações do nó estão sendo alteradas. NetAddressCreating: Uma conexão de rede está sendo criada. NetAddressDeleting: Uma conexão de rede está sendo excluída. NetAddressModifying: Uma conexão de rede está sendo modificada. Deleted: O cluster está excluído. ClassChanged: Os recursos estão sendo recuperados após o upgrade ou downgrade.	Running
PayType	string	Não	O método de cobrança. Valores válidos: Postpaid: pay-as-you-go Prepaid: assinatura	Prepaid
RegionId	string	Sim	O ID da região.	cn-hangzhou
AiNodeType	string	Não	O tipo de nó. Para especificar vários tipos, separe-os com uma vírgula. Valores válidos: vnode: um nó gerenciado pelo Kubernetes container: um contêiner no qual você pode fazer login maas: serviço de modelo	vnode,container
Tag	array<object>	Não	Uma lista de tags.
	object	Não
Key	string	Não	A chave da tag. Use este parâmetro com Tag.n.Value para filtrar clusters por tag. Você pode especificar até 20 pares de tags. O índice n deve ser um número inteiro exclusivo e consecutivo começando em 1.	testKey
Value	string	Não	O valor da tag.	testValueData

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	9D6CE7C6-1C52-5BF6-B3D7-10977D44542C
TotalRecordCount	integer	O número total de entradas.	5
PageRecordCount	integer	O número de entradas na página atual.	7
PageNumber	integer	O número da página. Valor padrão: 1.	1
Items	object	Os detalhes dos clusters de IA.
DBCluster	array<object>	Uma lista de instâncias de cluster de IA.
	array<object>	As propriedades da instância do cluster de IA.
DBClusterId	string	The cluster ID.	pc-**************
RegionId	string	The region ID.	cn-hangzhou
ZoneId	string	The zone ID.	cn-hangzhou-j
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DBClusterStatus	string	The status of the cluster.	Creating
DBClusterDescription	string	The description of the cluster.	ocpx
VpcId	string	The VPC ID.	vpc-***************
DBNodeClass	string	The node class.	polar.pg.g8.8xlarge.gu30
StorageType	string	The storage type. Valid values: essdpl0 essdpl1 essdpl2 essdpl3	essdpl0
StorageSpace	integer	The storage space. Unit: GB.	10
ExpireTime	string	The expiration time. Nota This parameter is returned only for subscription clusters. For pay-as-you-go clusters, this parameter is empty.	2028-09-01T16:00:00Z
Expired	boolean	Indicates whether the cluster has expired. Valid values: true false	False
LockMode	string	The lock state of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The system automatically locks the cluster upon expiration.	Unlock
CreateTime	string	The time the cluster was created.	2021-09-13T15:45:27Z
KubeClusterId	string	The ID of the Container Service for Kubernetes (ACK) cluster.	xxxxxxxxxxxx
RunType	string	The run type. Valid values: `container`: The service runs in a container. `default`: The service runs on a node.	container
DBType	string	The database engine type. Only polardb_ai is supported.	polardb_ai
AiNodeType	string	The node type. Valid values: vnode: a node managed by Kubernetes; container: a container that supports logon; maas: a model service.	vnode
Tags	object	The tags of the cluster.
Tag	array<object>	A list of tags.
	object	A tag attached to the cluster.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValueData
VswitchId	string	The VSwitch ID.	vsw-**************
RelativeDBClusterId	string	The ID of the associated cluster instance.	pc-**************
ModelType	string	The model type.	custom

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9D6CE7C6-1C52-5BF6-B3D7-10977D44542C",
  "TotalRecordCount": 5,
  "PageRecordCount": 7,
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DBClusterId": "pc-**************",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-j",
        "PayType": "Postpaid",
        "DBClusterStatus": "Creating",
        "DBClusterDescription": "ocpx",
        "VpcId": "vpc-***************",
        "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
        "StorageType": "essdpl0",
        "StorageSpace": 10,
        "ExpireTime": "2028-09-01T16:00:00Z",
        "Expired": true,
        "LockMode": "Unlock",
        "CreateTime": "2021-09-13T15:45:27Z",
        "KubeClusterId": "xxxxxxxxxxxx",
        "RunType": "container",
        "DBType": "polardb_ai",
        "AiNodeType": "vnode",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValueData"
            }
          ]
        },
        "VswitchId": "vsw-**************",
        "RelativeDBClusterId": "pc-**************",
        "ModelType": "custom"
      }
    ]
  }
}

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.