DescribeClusterResources - Container Service for Kubernetes: Central de Documentação do Alibaba Cloud

O Container Service for Kubernetes usa outros recursos da Alibaba Cloud, como VPCs e SLBs. Para consultar os recursos associados a um cluster específico, chame a operação DescribeClusterResources. Para consultar pools de nós ou nós, chame as operações DescribeClusterNodePools ou DescribeClusterNodes.

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

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

Nenhuma

Sintaxe da solicitação

GET /clusters/{ClusterId}/resources HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID do cluster. Para obter informações sobre como visualizar o ID do cluster, consulte Visualizar informações do cluster. Você também pode chamar a operação DescribeClustersV1 para consultar todos os clusters em sua conta da Alibaba Cloud.	cb95aa626a47740afbf6aa099b65****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
with_addon_resources	boolean	Não	Especifica se os recursos criados pelos complementos do cluster devem ser consultados. true: Os recursos dos complementos são incluídos. false: Os recursos dos complementos não são incluídos.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	array	Uma lista de objetos de recurso.
	array<object>	Os detalhes do recurso.
cluster_id	string	O ID do cluster.	cb95aa626a47740afbf6aa099b65****
created	string	A hora em que o recurso foi criado.	2023-08-15T14:34:42+08:00
instance_id	string	O ID do recurso.	ngw-wz9sphwk42sdtjixo****
resource_info	string	Informações sobre o recurso. Para mais detalhes sobre sua origem, consulte ListStackResources.	{\"Id\":\"KubernetesWorkerRole\",\"Name\":\"KubernetesWorkerRole\",\"Type\":\"ALIYUN::RAM::Role\",\"Status\":\"CREATE_COMPLETE\",\"StatusReason\":\"state changed\",\"Updated\":\"2025-04-10T06:21:17\",\"PhysicalId\":\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\"}
resource_type	string	O tipo de recurso.	ALIYUN::VPC::NatGateway
state	string	O estado do recurso. Valores válidos: `CREATE_COMPLETE`: O recurso foi criado com êxito. `CREATE_FAILED`: Falha ao criar o recurso. `CREATE_IN_PROGRESS`: O recurso está sendo criado. `DELETE_FAILED`: Falha ao excluir o recurso. `DELETE_IN_PROGRESS`: O recurso está sendo excluído. `ROLLBACK_COMPLETE`: A reversão foi bem-sucedida. `ROLLBACK_FAILED`: Falha na reversão. `ROLLBACK_IN_PROGRESS`: A reversão está em andamento.	CREATE_COMPLETE
auto_create	integer	Indica se o recurso é criado pelo ACK. Valores válidos: 1: O recurso é criado pelo ACK. 0: O recurso é um recurso existente.	1
dependencies	array<object>	A lista de recursos dependentes.
	object	Os detalhes do recurso dependente.
cluster_id	string	O ID do cluster do recurso dependente.	cc5ee03f63e43425cb6f71f1a1756****
resource_type	string	O tipo do recurso dependente.	ALIYUN::VPC::NatGateway
instance_id	string	O ID da instância do recurso dependente.	ngw-wz9sphwk42sdtjixo****
associated_object	object	O objeto Kubernetes associado ao recurso.
kind	string	O tipo do objeto Kubernetes.	Service
namespace	string	O namespace do objeto Kubernetes.	kube-system
name	string	O nome do objeto Kubernetes.	nginx-ingress-lb
delete_behavior	object	O comportamento de exclusão do recurso quando o cluster é excluído.
delete_by_default	boolean	Indica se o recurso deve ser excluído por padrão quando o cluster é excluído. Valores válidos: true: O recurso é excluído por padrão. false: O recurso não é excluído por padrão.	false
changeable	boolean	Indica se o comportamento padrão especificado pelo parâmetro `delete_by_default` pode ser alterado. Valores válidos: true: O comportamento padrão pode ser alterado. false: O comportamento padrão não pode ser alterado.	false
creator_type	string	O tipo do criador do recurso. Valores válidos: user: O recurso é criado por um usuário. system: O recurso é criado pelo plano de controle do ACK. addon: O recurso é criado por um complemento.	addon
extra_info	object	Informações adicionais sobre o recurso.	{ "type": "SLS_Data" }

Exemplos

Resposta de sucesso

JSON formato

[
  {
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "created": "2023-08-15T14:34:42+08:00",
    "instance_id": "ngw-wz9sphwk42sdtjixo****",
    "resource_info": "{\\\"Id\\\":\\\"KubernetesWorkerRole\\\",\\\"Name\\\":\\\"KubernetesWorkerRole\\\",\\\"Type\\\":\\\"ALIYUN::RAM::Role\\\",\\\"Status\\\":\\\"CREATE_COMPLETE\\\",\\\"StatusReason\\\":\\\"state changed\\\",\\\"Updated\\\":\\\"2025-04-10T06:21:17\\\",\\\"PhysicalId\\\":\\\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\\\"}",
    "resource_type": "ALIYUN::VPC::NatGateway",
    "state": "CREATE_COMPLETE",
    "auto_create": 1,
    "dependencies": [
      {
        "cluster_id": "cc5ee03f63e43425cb6f71f1a1756****",
        "resource_type": "ALIYUN::VPC::NatGateway",
        "instance_id": "ngw-wz9sphwk42sdtjixo****"
      }
    ],
    "associated_object": {
      "kind": "Service",
      "namespace": "kube-system",
      "name": "nginx-ingress-lb"
    },
    "delete_behavior": {
      "delete_by_default": false,
      "changeable": false
    },
    "creator_type": "addon",
    "extra_info": {
      "type": "SLS_Data"
    }
  }
]

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.