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

Invoca a operação DescribeAddon para realizar uma consulta de parâmetros sobre informações de um componente especificado com base em parâmetros como região, tipo de cluster, subclasse do cluster (profile), versão do cluster e nome do componente. As informações retornadas incluem se o componente é gerenciado, a categorização do componente, o esquema de parâmetros personalizados suportados, as arquiteturas de sistema operacional compatíveis e a versão mínima do cluster exigida pela versão do componente.

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

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /addons/{addon_name} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
addon_name	string	Não	O nome do componente.	coredns.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
region_id	string	Não	O ID da região. Se cluster_id for especificado, este parâmetro será ignorado. Os parâmetros region_id, cluster_type, profile, cluster_spec e cluster_version devem ser especificados juntos.	cn-hangzhou.
cluster_type	string	Não	O tipo de cluster. Se cluster_id for especificado, este parâmetro será ignorado. Os parâmetros region_id, cluster_type, profile, cluster_spec e cluster_version devem ser especificados juntos.	ManagedKubernetes.
profile	string	Não	O subtipo de cluster. Se cluster_id for especificado, este parâmetro será ignorado. Os parâmetros region_id, cluster_type, profile, cluster_spec e cluster_version devem ser especificados juntos.	Default.
cluster_spec	string	Não	As especificações do cluster. Se cluster_id for especificado, este parâmetro será ignorado. Os parâmetros region_id, cluster_type, profile, cluster_spec e cluster_version devem ser especificados juntos.	ack.pro.small.
cluster_version	string	Não	A versão do cluster. Se cluster_id for especificado, este parâmetro será ignorado. Os parâmetros region_id, cluster_type, profile, cluster_spec e cluster_version devem ser especificados juntos.	1.26.3-aliyun.1
cluster_id	string	Não	O ID do cluster. Se você especificar um ID de cluster, o sistema consultará a lista de componentes disponíveis para o cluster e os outros parâmetros serão ignorados.	c02b3e03be10643e8a644a843ffcb****
version	string	Não	A versão do componente. Se este parâmetro não for especificado, a versão mais recente disponível do componente será consultada.	v1.9.3.10-7dfca203-aliyun.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
name	string	O nome do componente.	coredns.
version	string	A versão do componente.	v1.9.3.6-32932850-aliyun.
category	string	A categoria do componente.	network.
managed	boolean	Indica se o componente é gerenciado.	false.
install_by_default	boolean	Indica se o componente é instalado por padrão.	true.
config_schema	string	O esquema de parâmetros personalizados para o componente.	{}
supported_actions	array	As operações suportadas pelo componente.
	string	As operações suportadas pelo componente. Valores válidos: Install: instala o componente. Upgrade: atualiza o componente. Modify: modifica o componente. Uninstall: desinstala o componente.	Install.
architecture	array	As arquiteturas de CPU suportadas pelo componente.
	string	As arquiteturas de CPU suportadas pelo componente. Valores válidos: amd64. arm64.	amd64
newer_versions	array<object>	As informações sobre versões mais recentes do componente.
	object	As informações sobre uma versão mais recente.
version	string	O número da versão mais recente do componente.	v1.9.3.10-7dfca203-aliyun.
upgradable	boolean	Indica se o componente pode ser atualizado para esta versão. true: A atualização é suportada. false: A atualização não é suportada.	true.
minimum_cluster_version	string	A versão mínima do cluster exigida por esta versão do componente.	1.20.4

Exemplos

Resposta de sucesso

JSON formato

{
  "name": "coredns.",
  "version": "v1.9.3.6-32932850-aliyun.",
  "category": "network.",
  "managed": true,
  "install_by_default": true,
  "config_schema": "{}",
  "supported_actions": [
    "Install."
  ],
  "architecture": [
    "amd64"
  ],
  "newer_versions": [
    {
      "version": "v1.9.3.10-7dfca203-aliyun.",
      "upgradable": true,
      "minimum_cluster_version": "1.20.4"
    }
  ]
}

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.