Listagem de modelos de complemento
Função
Essa API é usada para consultar modelos de complementos.
URI
GET /api/v3/addontemplates
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| addon_template_name | Não | String | Nome ou alias do complemento para pesquisa. Se este parâmetro não for especificado, todos os complementos serão pesquisados. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Content-Type | Sim | String | Tipo de corpo da mensagem (formato). |
| X-Auth-Token | Sim | String | As solicitações para chamar uma API podem ser autenticadas usando um token ou AK/SK. Se a autenticação baseada em token for usada, esse parâmetro é obrigatório e deve ser definido como um token de usuário. Para obter detalhes, consulte Obtenção de um token de usuário. |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| kind | String | Tipo de API. O valor é fixado em Addon e não pode ser alterado. |
| apiVersion | String | Versão da API. O valor é fixado em v3 e não pode ser alterado. |
| items | Array of AddonTemplate objects | Lista de todos os modelos de complementos. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| kind | String | Tipo de API. O valor é fixado em Addon e não pode ser alterado. |
| apiVersion | String | Versão da API. O valor é fixado em v3 e não pode ser alterado. |
| metadata | AddonMetadata object | Informações básicas sobre o objeto. Metadados são uma coleção de atributos. |
| spec | Templatespec object | Descrição detalhada do modelo de complemento. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| uid | String | ID único |
| name | String | Nome do complemento |
| alias | String | Alias do complemento |
| labels | Map<String,String> | Rótulos do complemento em pares chave-valor. Este é um campo reservado e não tem efeito. |
| annotations | Map<String,String> | Anotações do complemento, no formato de pares chave-valor.
|
| updateTimestamp | String | Atualizado em |
| creationTimestamp | String | Criado em |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| type | String | Tipo de modelo. O valor é helm ou static. |
| require | Boolean | Se o complemento é obrigatório. |
| labels | Array of strings | Grupo ao qual o modelo pertence. |
| logoURL | String | URL da imagem do logotipo. |
| readmeURL | String | Detalhes do complemento e descrição de uso. |
| description | String | Descrição |
| versions | Array of Versions objects | Detalhes da versão do modelo. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| version | String | Versão do complemento. |
| input | Object | Parâmetros de instalação do complemento. |
| stable | Boolean | Se a versão do complemento é uma versão estável. |
| translate | Object | Informações de tradução usadas pela GUI. |
| supportVersions | Array of SupportVersions objects | Versões de cluster que suportam o complemento. |
| creationTimestamp | String | Hora de criação. |
| updateTimestamp | String | Hora da atualização. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
OK
{
"kind" : "Addon",
"apiVersion" : "v3",
"items" : [ {
"kind" : "Addon",
"apiVersion" : "v3",
"metadata" : {
"uid" : "coredns",
"name" : "coredns",
"alias" : "coredns",
"creationTimestamp" : "2018-11-04T16:15:56Z",
"updateTimestamp" : "2022-01-11T14:32:10Z"
},
"spec" : {
"type" : "helm",
"require" : true,
"labels" : [ "ServiceDiscovery" ],
"logoURL" : "",
"description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services",
"versions" : [ {
"version" : "1.13.6",
"input" : {
"basic" : {
"cluster_ip" : "10.247.3.10",
"ipv6" : false,
"platform" : "linux-amd64",
"swr_addr" : "100.125.16.65:20202",
"swr_user" : "hwofficial"
},
"parameters" : {
"custom" : {
"stub_domains" : "",
"upstream_nameservers" : ""
},
"flavor1" : {
"name" : 2500,
"replicas" : 2,
"resources" : [ {
"limitsCpu" : "500m",
"limitsMem" : "512Mi",
"name" : "coredns",
"requestsCpu" : "500m",
"requestsMem" : "512Mi"
} ]
},
"flavor2" : {
"name" : 5000,
"replicas" : 2,
"resources" : [ {
"limitsCpu" : "1000m",
"limitsMem" : "1024Mi",
"name" : "coredns",
"requestsCpu" : "1000m",
"requestsMem" : "1024Mi"
} ]
},
"flavor3" : {
"name" : 10000,
"replicas" : 2,
"resources" : [ {
"limitsCpu" : "2000m",
"limitsMem" : "2048Mi",
"name" : "coredns",
"requestsCpu" : "2000m",
"requestsMem" : "2048Mi"
} ]
},
"flavor4" : {
"name" : 20000,
"replicas" : 4,
"resources" : [ {
"limitsCpu" : "2000m",
"limitsMem" : "2048Mi",
"name" : "coredns",
"requestsCpu" : "2000m",
"requestsMem" : "2048Mi"
} ]
}
}
},
"stable" : true,
"translate" : {
"en_US" : {
"addon" : {
"changeLog" : "Support for clusters with new version",
"description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services"
},
"description" : {
"Parameters.custom.stub_domains" : "The target nameserver may itself be a Kubernetes service. For instance, you can run your own copy of dnsmasq to export custom DNS names into the ClusterDNS namespace, a JSON map using a DNS suffix key (e.g. \"acme.local\") and a value consisting of a JSON array of DNS IPs.",
"Parameters.custom.upstream_nameservers" : "If specified, then the values specified replace the nameservers taken by default from the node's /etc/resolv.conf. Limits:a maximum of three upstream nameservers can be specified, A JSON array of DNS IPs.",
"Parameters.flavor1.description" : "Concurrent domain name resolution ability - External domain name: 2500 qps, Internal domain name: 10000 qps",
"Parameters.flavor1.name" : 2500,
"Parameters.flavor2.description" : "Concurrent domain name resolution ability - External domain name: 5000 qps, Internal domain name: 20000 qps",
"Parameters.flavor2.name" : 5000,
"Parameters.flavor3.description" : "Concurrent domain name resolution ability - External domain name: 10000 qps, Internal domain name: 40000 qps",
"Parameters.flavor3.name" : 10000,
"Parameters.flavor4.description" : "Concurrent domain name resolution ability - External domain name: 20000 qps, Internal domain name: 80000 qps",
"Parameters.flavor4.name" : 20000
},
"key" : {
"Parameters.custom.stub_domains" : "stub domain",
"Parameters.custom.upstream_nameservers" : "upstream nameservers"
}
},
"fr_FR" : {
"addon" : {
"changeLog" : "Prise en charge des clusters avec une nouvelle version",
"description" : "Un serveur DNS qui enchaîne les plug-ins et fournit des services DNS Kubernetes."
},
"description" : {
"Parameters.custom.stub_domains" : "Le serveur de noms cible peut lui-même être un service Kubernetes. Par exemple, vous pouvez exécuter votre propre copie de dnsmasq pour exporter des noms DNS personnalisés dans l'espace de noms ClusterDNS, une carte JSON à l'aide d'une clé de suffixe DNS (par exemple, «acme.local») et une valeur constituée d'un tableau JSON d'adresses IP DNS.",
"Parameters.custom.upstream_nameservers" : "Si spécifié, les valeurs spécifiées remplacent les serveurs de noms pris par défaut dans le fichier /etc/resolv.conf du nœud. Limites: un maximum de trois serveurs de noms en amont peuvent être spécifiés, un tableau JSON d'adresses IP DNS.",
"Parameters.flavor1.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 2500 qps, Nom de domaine interne: 10000 qp",
"Parameters.flavor1.name" : 2500,
"Parameters.flavor2.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 5000 qps, Nom de domaine interne: 20000 qp",
"Parameters.flavor2.name" : 5000,
"Parameters.flavor3.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 10000 qps, Nom de domaine interne: 40000 qp",
"Parameters.flavor3.name" : 10000,
"Parameters.flavor4.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 20000 qps, Nom de domaine interne: 80000 qp",
"Parameters.flavor4.name" : 20000
},
"key" : {
"Parameters.custom.stub_domains" : "domaine stub",
"Parameters.custom.upstream_nameservers" : "serveurs de noms en amont"
}
},
"zh_CN" : {
"addon" : {
"changeLog" : "",
"description" : ""
},
"description" : {
"Parameters.custom.stub_domains" : "",
"Parameters.custom.upstream_nameservers" : "",
"Parameters.flavor1.description" : "",
"Parameters.flavor1.name" : 2500,
"Parameters.flavor2.description" : "",
"Parameters.flavor2.name" : 5000,
"Parameters.flavor3.description" : "",
"Parameters.flavor3.name" : 10000,
"Parameters.flavor4.description" : "",
"Parameters.flavor4.name" : 20000
},
"key" : {
"Parameters.custom.stub_domains" : "",
"Parameters.custom.upstream_nameservers" : ""
}
}
},
"supportVersions" : [ {
"clusterType" : "VirtualMachine",
"clusterVersion" : [ "v1.13.*" ]
}, {
"clusterType" : "BareMetal",
"clusterVersion" : [ "v1.13.*" ]
}, {
"clusterType" : "ARM64",
"clusterVersion" : [ "v1.13.*" ]
} ],
"creationTimestamp" : "2021-03-18T12:51:05Z",
"updateTimestamp" : "2021-03-18T12:51:05Z"
} ]
}
} ]
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
Códigos de erro
Consulte Códigos de erro.