DescribeAddons - : Central de Documentação do Alibaba Cloud

Consulta os detalhes dos componentes instalados em um cluster do Container Service for Kubernetes (ACK) especificado.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente exemplos de código da operação para diferentes SDKs.

Sintaxe da requisição

GET /clusters/components/metadata?region=String&cluster_type=String HTTP/1.1 
Content-Type:application/json

Parâmetros da requisição

Tabela 1. Parâmetros de consulta da requisição
Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
region	String	Sim	cn-beijing	ID da região onde o cluster ACK está implantado.
cluster_type	String	Não	kubernetes	Tipo do cluster. Valores válidos: `Kubernetes`: cluster Kubernetes dedicado `ManagedKubernetes`: cluster Kubernetes gerenciado `Ask`: cluster ASK `ExternalKubernetes`: cluster Kubernetes externo registrado

Sintaxe da resposta

HTTP/1.1 200
Content-Type:application/json
{
  "ComponentGroups" : [ {
    "group_name" : "String",
    "items" : [ {
      "name" : "String"
    } ]
  } ],
  "StandardComponents" : {
    "key" : {
      "name" : "String",
      "version" : "String",
      "description" : "String",
      "required" : "String",
      "disabled" : Boolean
    }
  }
}

Parâmetros da resposta

Tabela 2. Parâmetros do corpo da resposta
Parâmetro	Tipo	Exemplo	Descrição
ComponentGroups	Array of ComponentGroup		Detalhes dos componentes retornados.
group_name	String	storage	Nome do grupo de componentes.
items	Array of item		Nomes dos componentes no grupo de componentes.
name	String	flexvolume	Nome do componente.
StandardComponents	Map		Componentes padrão.
	object		Detalhes dos componentes padrão.
name	String	ack-arena	Nome do componente.
version	String	0.5.0	Versão do componente.
description	String	***	Descrição do componente.
required	String	false	Indica se o componente é obrigatório em um cluster ACK. Valores válidos: `true`: o componente é obrigatório e deve ser instalado durante a criação do cluster ACK. `false`: o componente é opcional. Após criar o cluster ACK, acesse a página `Add-ons` no console ACK para instalar o componente.
disabled	Boolean	false	Indica se a instalação automática do componente está desativada. Por padrão, alguns componentes opcionais, como componentes de log e Ingresses, são instalados durante a criação do cluster ACK. Defina este parâmetro para desativar a instalação automática de um componente. Valores válidos: `true`: desativa a instalação automática do componente. `false`: permite a instalação automática do componente.

Exemplos

Exemplos de requisições

GET /clusters/components/metadata?region=cn-beijing    &cluster_type=kubernetes HTTP/1.1 
Content-Type:application/json

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<StandardComponents>
    <cloud-controller-manager>
        <name>cloud-controller-manager</name>
        <version>v1.9.3.339-g9830b58-aliyun</version>
        <disabled>false</disabled>
        <required>true</required>
        <description>name: Cloud Controller Manager introduction: Using Cloud Controller Manager to create load balancers for k8s applications and manage node route entries doc:en: https://www.alibabacloud.com/help/doc-detail/94925.htm</description>
    </cloud-controller-manager>
    <csi-plugin>
        <name>csi-plugin</name>
        <version>v1.16.9.43-f36bb540-aliyun</version>
        <disabled>false</disabled>
        <required>false</required>
        <description>csi-plugin</description>
    </csi-plugin>
</StandardComponents>
<ComponentGroups>
    <group_name>storage</group_name>
    <items>
        <name>flexvolume</name>
    </items>
    <items>
        <name>alicloud-disk-controller</name>
    </items>
    <items>
        <name>csi-plugin</name>
    </items>
    <items>
        <name>csi-provisioner</name>
    </items>
</ComponentGroups>
<ComponentGroups>
    <group_name>network</group_name>
    <items>
        <name>kube-flannel-ds</name>
    </items>
    <items>
        <name>terway</name>
    </items>
    <items>
        <name>terway-eni</name>
    </items>
    <items>
        <name>terway-eniip</name>
    </items>
    <items>
        <name>nginx-ingress-controller</name>
    </items>
    <items>
        <name>coredns</name>
    </items>
    <items>
        <name>managed-kube-proxy</name>
    </items>
</ComponentGroups>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "StandardComponents" : {
    "cloud-controller-manager" : {
      "name" : "cloud-controller-manager",
      "version" : "v1.9.3.339-g9830b58-aliyun",
      "disabled" : false,
      "required" : "true",
      "description" : "name: Cloud Controller Manager introduction: Using Cloud Controller Manager to create load balancers for k8s applications and manage node route entries doc:en: https://www.alibabacloud.com/help/doc-detail/94925.htm"
    },
    "csi-plugin" : {
      "name" : "csi-plugin",
      "version" : "v1.16.9.43-f36bb540-aliyun",
      "disabled" : false,
      "required" : "false",
      "description" : "csi-plugin"
    }
  },
  "ComponentGroups" : [ {
    "group_name" : "storage",
    "items" : [ {
      "name" : "flexvolume"
    }, {
      "name" : "alicloud-disk-controller"
    }, {
      "name" : "csi-plugin"
    }, {
      "name" : "csi-provisioner"
    } ]
  }, {
    "group_name" : "network",
    "items" : [ {
      "name" : "kube-flannel-ds"
    }, {
      "name" : "terway"
    }, {
      "name" : "terway-eni"
    }, {
      "name" : "terway-eniip"
    }, {
      "name" : "nginx-ingress-controller"
    }, {
      "name" : "coredns"
    }, {
      "name" : "managed-kube-proxy"
    } ]
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.