ListCluster - Enterprise Distributed Application Service: Central de Documentação do Alibaba Cloud

Consulta clusters.

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.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

edas:ReadCluster

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST /pop/v5/resource/cluster_list HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
LogicalRegionId	string	Não	O ID do namespace. Você pode chamar a operação ListUserDefineRegion para consultar o ID do namespace. Para mais informações, consulte ListUserDefineRegion. Se este parâmetro for deixado vazio, os clusters no namespace padrão serão consultados. Se este parâmetro for especificado, os clusters no namespace especificado serão consultados.	cn-beijing:test
ResourceGroupId	string	Não	O ID do grupo de recursos. Você pode chamar a operação ListResourceGroup para consultar o ID do grupo de recursos. Para mais informações, consulte ListResourceGroup. Se este parâmetro for deixado vazio, os clusters no grupo de recursos padrão serão consultados. Se este parâmetro for especificado, os clusters no grupo de recursos especificado serão consultados.	461

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de status HTTP retornado.	200
Message	string	As informações adicionais retornadas.	success
RequestId	string	O ID da solicitação.	1053-08e4-47a5-b2ab-5c0323de****
ClusterList	object
Cluster	array<object>	Os clusters.
	object
VpcId	string	VPC ID	vpc-23727****
OversoldFactor	integer	The CPU overcommit ratio that is supported by a Docker cluster. Valid values: 1: 1:1, which means that CPU resources are not overcommitted. 2: 1:2, which means that CPU resources are overcommitted by 1:2. 4: 1:4, which means that CPU resources are overcommitted by 1:4. 8: 1:8, which means that CPU resources are overcommitted by 1:8.	1
UpdateTime	integer	The timestamp when the cluster was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1533820823203
MemUsed	integer	The size of used memory. Unit: MB.	200
IaasProvider	string	The provider of the cluster.	ALIYUN
CreateTime	integer	The timestamp when the cluster was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1502888064561
CpuUsed	integer	The number of used CPU cores.	1
Mem	integer	The total size of memory. Unit: MB.	3072
RegionId	string	The ID of the region.	cn-beijing
Cpu	integer	The total number of CPU cores.	2
CsClusterId	string	The ID of the cluster in Container Service for Kubernetes (ACK).	c2ce************b9203a9
NetworkMode	integer	The network type of the cluster. Valid values: 1: classic network 2: virtual private cloud (VPC)	1
Description	string	The description of the cluster.	Test cluster
ClusterType	integer	The type of the cluster. Valid values: 0: regular Docker cluster 1: Swarm cluster 2: Elastic Compute Service (ECS) cluster 3: self-managed Kubernetes cluster in Enterprise Distributed Application Service (EDAS) 4: cluster in which Pandora automatically registers applications 5: ACK cluster	2
ResourceGroupId	string	The ID of the resource group.	461
ClusterName	string	The name of the cluster.	cluster-test
NodeNum	integer	The number of instances.	2
ClusterId	string	The ID of the cluster in EDAS.	b98b5919-c111-4dad-9f74-7233********

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "success",
  "RequestId": "1053-08e4-47a5-b2ab-5c0323de****",
  "ClusterList": {
    "Cluster": [
      {
        "VpcId": "vpc-23727****",
        "OversoldFactor": 1,
        "UpdateTime": 1533820823203,
        "MemUsed": 200,
        "IaasProvider": "ALIYUN",
        "CreateTime": 1502888064561,
        "CpuUsed": 1,
        "Mem": 3072,
        "RegionId": "cn-beijing",
        "Cpu": 2,
        "CsClusterId": "c2ce************b9203a9",
        "NetworkMode": 1,
        "Description": "Test cluster",
        "ClusterType": 2,
        "ResourceGroupId": "461",
        "ClusterName": "cluster-test",
        "NodeNum": 2,
        "ClusterId": "b98b5919-c111-4dad-9f74-7233********"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de ErroCódigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de VersãoNotas de Versão para uma lista completa.