Todos os produtos
Search
Central de documentação

Container Service for Kubernetes:DescribeClustersForRegion

Última atualização: Jun 29, 2026

Lista todos os clusters em uma região especificada.

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

cs:DescribeClustersForRegion

list

*All Resource

*

Nenhuma Nenhuma

Sintaxe da solicitação

GET /regions/{region_id}/clusters HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

region_id

string

Sim

O ID da região.

cn-hangzhou

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

name

string

Não

O nome do cluster. A pesquisa difusa é suportada.

test-cluster

cluster_type

string

Não

O tipo do cluster. Valores válidos:

  • Kubernetes: um cluster dedicado do ACK.

  • ManagedKubernetes: um cluster gerenciado do ACK. Inclui clusters gerenciados do ACK (edições Pro e Basic), clusters ACK Serverless (edições Pro e Basic), clusters ACK Edge (edições Pro e Basic) e clusters ACK Lingjun (edição Pro).

  • ExternalKubernetes: um cluster registrado.

Valores válidos:

  • ExternalKubernetes :

    ExternalKubernetes.

  • ManagedKubernetes :

    ManagedKubernetes.

  • Kubernetes :

    Kubernetes.

Kubernetes

page_size

integer

Não

O número de entradas por página.

3

page_number

integer

Não

O número da página.

10

profile

string

Não

O subtipo do cluster. Valores válidos:

  • Default: um cluster gerenciado do ACK. Inclui as edições Pro e Basic.

  • Edge: um cluster ACK Edge. Inclui as edições Pro e Basic.

  • Serverless: um cluster ACK Serverless. Inclui as edições Pro e Basic.

  • LingJun: um cluster ACK Lingjun (edição Pro).

Valores válidos:

  • LingJun :

    LingJun.

  • Serverless :

    Serverless.

  • Default :

    Default.

  • Edge :

    Edge.

Serverless

cluster_spec

string

Não

A especificação do cluster. Valores válidos:

  • ack.standard: edição Basic

  • ack.pro.small: edição Pro

  • ack.pro.xlarge: Pro XL

  • ack.pro.2xlarge: Pro 2XL

  • ack.pro.4xlarge: Pro 4XL (Entre em contato com o suporte ao cliente para adicionar esta especificação à lista de permissões.)

Pro XL, Pro 2XL e Pro 4XL são três níveis do plano de controle provisionado do ACK Pro. Esses níveis garantem um alto nível consistente de concorrência de API e capacidades de agendamento de pods por meio da pré-alocação e dedicação de recursos do plano de controle. São adequados para treinamento e inferência de IA, clusters de grande escala e serviços de missão crítica.

Para informações sobre a taxa de gerenciamento de cluster para a edição Pro e as edições de plano de controle provisionado, consulte taxa de gerenciamento de cluster.

Valores válidos:

  • ack.pro.small :

    ack.pro.small.

  • ack.standard :

    ack.standard.

ack.standard

cluster_id

string

Não

O ID do cluster.

c8155823d057948c69a****

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O corpo da resposta.

clusters

array<object>

Uma lista de detalhes dos clusters.

object

Os detalhes de um cluster.

cluster_id

string

O ID do cluster.

c905d1364c2dd4b6284a3f41790c4****

cluster_type

string

O tipo do cluster. Valores válidos:

  • Kubernetes: cluster dedicado do ACK.

  • ManagedKubernetes: clusters gerenciados do ACK, incluindo os clusters gerenciados padrão do ACK (Pro e Basic), clusters ACK Serverless (Pro e Basic), clusters ACK Edge (Pro e Basic) e clusters ACK Lingjun (Pro).

  • ExternalKubernetes: cluster registrado.

ManagedKubernetes

created

string

A hora em que o cluster foi criado.

2020-12-01T20:40:40+08:00

init_version

string

A versão inicial do cluster.

1.16.6-aliyun.1

current_version

string

A versão atual do cluster.

1.16.6-aliyun.1

next_version

string

A versão para a qual o cluster pode ser atualizado.

1.18.8-aliyun.1

deletion_protection

boolean

Especifica se a proteção contra exclusão está ativada. Se este parâmetro estiver definido como true, o cluster não poderá ser excluído no console ou por uma chamada de API. Valores válidos:

  • true: a proteção contra exclusão está ativada.

  • false: a proteção contra exclusão está desativada.

false

name

string

O nome do cluster.

test-cluster

profile

string

O subtipo do cluster. Valores válidos:

  • Default: clusters gerenciados do ACK, que incluem as edições Pro e Basic.

  • Edge: clusters ACK Edge, que incluem as edições Pro e Basic.

  • Serverless: clusters ACK Serverless, que incluem as edições Pro e Basic.

  • LingJun: clusters ACK Lingjun, disponíveis apenas na edição Pro.

Default

region_id

string

O ID da região.

cn-beijing-a

resource_group_id

string

O ID do grupo de recursos ao qual o cluster pertence.

rg-acfmyvw3wjm****

security_group_id

string

O ID do grupo de segurança ao qual o cluster pertence.

sg-2zeihch86ooz9io4****

container_cidr

string

O bloco CIDR da rede de Pods.

172.20.0.0/16

service_cidr

string

O bloco CIDR de serviço.

172.21.0.0/20

proxy_mode

string

O modo kube-proxy do cluster.

Valores válidos:

  • iptables :

    iptables.

  • ipvs :

    ipvs.

ipvs

timezone

string

O fuso horário do cluster.

Asia/Shanghai

ip_stack

string

A pilha IP do cluster.

ipv4

cluster_domain

string

O domínio do cluster.

cluster.local

size

integer

O número de nós no cluster.

2

state

string

O estado do ciclo de vida do cluster. Valores válidos:

  • initial: o cluster está sendo criado.

  • failed: falha na criação do cluster.

  • running: o cluster está em execução.

  • updating: o cluster está sendo atualizado.

  • upgrading: o cluster está sendo atualizado para uma versão superior.

  • removing: os nós estão sendo removidos do cluster.

  • draining: os nós do cluster estão sendo drenados.

  • scaling: o cluster está sendo escalado.

  • inactive: o cluster está inativo.

  • unavailable: o cluster está indisponível.

  • deleting: o cluster está sendo excluído.

  • deleted: o cluster foi excluído.

  • delete_failed: falha na exclusão do cluster.

  • waiting: o cluster está aguardando conexão.

  • disconnected: o cluster está desconectado.

running

tags

array

Uma lista de tags do cluster.

tag

Uma tag do cluster.

updated

string

A hora da última atualização do cluster.

2020-12-08T15:37:00+08:00

vpc_id

string

O ID da VPC onde o cluster está implantado.

vpc-2zeg8nf1ukc0fcmvq****

vswitch_ids

array

Uma lista de IDs de vSwitch para o plano de controle do cluster.

string

O ID do vSwitch para o plano de controle.

vsw-2vc41xuumx5z2rdma****

cluster_spec

string

A especificação do cluster. Valores válidos:

  • ack.standard: edição Basic

  • ack.pro.small: edição Pro

  • ack.pro.xlarge: Pro XL

  • ack.pro.2xlarge: Pro 2XL

  • ack.pro.4xlarge: Pro 4XL (Esta especificação está disponível apenas para usuários na lista de permissões. Para utilizá-la, entre em contato com o serviço ao cliente.)

Pro XL, Pro 2XL e Pro 4XL são três especificações disponíveis para o plano de controle provisionado do ACK Pro. Essas especificações pré-alocam e dedicam recursos do plano de controle para garantir alta concorrência de API e capacidades de agendamento de Pods. São adequadas para treinamento e inferência de IA, clusters de grande escala e serviços de missão crítica.

Para informações sobre as taxas de gerenciamento de cluster para a edição Pro e as edições de plano de controle provisionado, consulte Taxa de gerenciamento de cluster.

ack.standard

page_info

object

As informações de paginação.

page_number

integer

O número da página.

1

page_size

integer

O número de entradas por página.

10

total_count

integer

O número total de entradas.

10

Exemplos

Resposta de sucesso

JSON formato

{
  "clusters": [
    {
      "cluster_id": "c905d1364c2dd4b6284a3f41790c4****",
      "cluster_type": "ManagedKubernetes",
      "created": "2020-12-01T20:40:40+08:00",
      "init_version": "1.16.6-aliyun.1",
      "current_version": "1.16.6-aliyun.1",
      "next_version": "1.18.8-aliyun.1",
      "deletion_protection": false,
      "name": "test-cluster",
      "profile": "Default",
      "region_id": "cn-beijing-a",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2zeihch86ooz9io4****",
      "container_cidr": "172.20.0.0/16",
      "service_cidr": "172.21.0.0/20",
      "proxy_mode": "ipvs",
      "timezone": "Asia/Shanghai",
      "ip_stack": "ipv4",
      "cluster_domain": "cluster.local",
      "size": 2,
      "state": "running",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "updated": "2020-12-08T15:37:00+08:00",
      "vpc_id": "vpc-2zeg8nf1ukc0fcmvq****",
      "vswitch_ids": [
        "vsw-2vc41xuumx5z2rdma****"
      ],
      "cluster_spec": "ack.standard"
    }
  ],
  "page_info": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 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.