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

Consulta todos os recursos de um cluster pelo ID do cluster.

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 mais informações sobre como consultar IDs de cluster, consulte Visualizar informações do cluster. Você também pode chamar a operação de API DescribeClustersV1 para consultar todos os clusters que pertencem a uma 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 componentes do cluster devem ser consultados.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	array	A lista de recursos do cluster.
	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	As informações do recurso. Para obter mais informações sobre como consultar as informações de origem do recurso, 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 status do recurso. Valores válidos: `CREATE_COMPLETE`: o recurso foi criado. `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`: o recurso foi revertido. `ROLLBACK_FAILED`: falha ao reverter o recurso. `ROLLBACK_IN_PROGRESS`: o recurso está sendo revertido.	CREATE_COMPLETE
auto_create	integer	Especifica se o recurso é criado pelo Container Service for Kubernetes (ACK). Valores válidos: 1: o recurso é criado pelo ACK. 0: o recurso é um recurso existente.	1
dependencies	array<object>	Os recursos dependentes.
	object	Os detalhes dos recursos dependentes.
cluster_id	string	O ID do cluster ao qual o recurso dependente está relacionado.	cc5ee03f63e43425cb6f71f1a1756****
resource_type	string	O tipo de recurso dependente.	ALIYUN::VPC::NatGateway
instance_id	string	O ID do recurso dependente.	ngw-wz9sphwk42sdtjixo****
associated_object	object	O objeto Kubernetes ao qual o recurso está associado.
kind	string	O tipo de objeto Kubernetes.	Service
namespace	string	O namespace no qual o objeto Kubernetes reside.	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	Especifica se o recurso deve ser excluído por padrão quando o cluster é excluído.	false
changeable	boolean	Especifica se o comportamento padrão retornado em delete_by_default pode ser alterado.	false
creator_type	string	O tipo do criador do recurso. Valores válidos: user: o recurso é criado pelo usuário. system: o recurso é criado pelo sistema de gerenciamento do ACK. addon: o recurso é criado por um componente do cluster.	addon
extra_info	object	As 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.