Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Cloud Container Engine/ Referência de API/ APIs/ Gerenciamento de complementos/ Consulta de uma instância de complemento
Atualizado em 2024-09-10 GMT+08:00
Ver PDF
Compartilhar

Consulta de uma instância de complemento

Função

Esta API é usada para obter detalhes sobre uma instância de complemento.

URI

GET /api/v3/addons/{id}

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

id

Sim

String

ID da instância do complemento.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

cluster_id

Não

String

ID do cluster. Para obter detalhes sobre como obter um ID do cluster, consulte Como obter parâmetros no URI da API.

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho 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

Tabela 4 Parâmetros do corpo de resposta

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

InstanceSpec object

Descrição detalhada da instância do complemento.

status

AddonInstanceStatus object

Status da instância do complemento.
Tabela 5 AddonMetadata

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.

  • Para instalação do complemento, o valor é fixado em {"addon.install/type":"install"}.

  • Para a atualização do complemento, o valor é fixado em {"addon.upgrade/type":"upgrade"}.

updateTimestamp

String

Atualizado em

creationTimestamp

String

Criado em
Tabela 6 InstanceSpec

Parâmetro

Tipo

Descrição

clusterID

String

ID do cluster.

version

String

Versão do modelo de complemento, por exemplo, 1.0.0.

addonTemplateName

String

Nome do modelo de complemento, por exemplo, coredns.

addonTemplateType

String

Tipo de modelo de complemento.

addonTemplateLogo

String

URL para obter o logotipo do modelo de complemento.

addonTemplateLabels

Array of strings

Rótulos do modelo de complemento.

description

String

Descrição do modelo de complemento.

values

Map<String,Object>

Parâmetros de instalação do modelo de complemento (variando dependendo do complemento). Defina os parâmetros de acordo.
Tabela 7 AddonInstanceStatus

Parâmetro

Tipo

Descrição

status

String

Status de instâncias do complemento. Opções:

  • running: todas as instâncias do complemento estão em execução e o complemento está em execução corretamente.

  • abnormal: as instâncias do complemento são anormais e o complemento não pode ser usado. Clique no nome do complemento para ver as exceções.

  • installing: o complemento está sendo instalado.

  • installFailed: falhou ao instalar o complemento. Nesse caso, desinstale o complemento e reinstale-o.

  • upgrading: o complemento está sendo atualizado.

  • upgradeFailed: falhou ao atualizar o complemento. Nesse caso, atualize o complemento novamente ou desinstale o complemento e reinstale-o.

  • deleting: o complemento está sendo excluído.

  • deleteFailed: falhou ao excluir o complemento. Nesse caso, desinstale o complemento novamente.

  • deleteSuccess: a exclusão do complemento foi bem-sucedida.

  • available: apenas algumas instâncias do complemento estão em execução. Isso indica que algumas funções do complemento estão disponíveis.

  • rollbacking: o complemento está sendo revertido.

  • rollbackFailed: falhou ao reverter o complemento. Nesse caso, reverta o complemento novamente ou desinstale o complemento e reinstale-o.

  • unknown: a instância do gráfico de complemento não existe.

Reason

String

Causa da falha na instalação do complemento.

message

String

Detalhes do erro de instalação.

targetVersions

Array of strings

Versões para as quais a versão atual do complemento pode ser atualizada.

currentVersion

Versions object

Informações sobre a versão atual do complemento.

isRollbackable

Boolean

Se a versão do complemento pode ser revertida para a versão de origem.

previousVersion

String

A versão do complemento antes da atualização ou reversão
Tabela 8 Versions

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.
Tabela 9 SupportVersions

Parâmetro

Tipo

Descrição

clusterType

String

Tipo de cluster que suporta o suplemento.

clusterVersion

Array of strings

Versões de cluster que suportam o complemento. O valor é uma expressão regular.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "24b23108-55c0-11e9-926f-0255ac101a31",
    "name" : "gpu-beta",
    "alias" : "gpu",
    "creationTimestamp" : "2019-04-03T03:25:34Z",
    "updateTimestamp" : "2019-04-03T03:25:34Z"
  },
  "spec" : {
    "clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
    "version" : "1.0.0",
    "addonTemplateName" : "gpu-beta",
    "addonTemplateType" : "helm",
    "addonTemplateLogo" : "",
    "addonTemplateLabels" : [ "Accelerator" ],
    "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
    "values" : {
      "basic" : {
        "rbac_enabled" : true,
        "swr_addr" : "100.125.6.246:20202",
        "swr_user" : "hwofficial"
      }
    }
  },
  "status" : {
    "status" : "installing",
    "Reason" : "",
    "message" : "",
    "targetVersions" : null,
    "currentVersion" : {
      "version" : "1.0.0",
      "input" : {
        "basic" : {
          "swr_addr" : "100.125.6.246:20202",
          "swr_user" : "hwofficial"
        },
        "parameters" : { }
      },
      "stable" : true,
      "translate" : {
        "en_US" : {
          "addon" : {
            "changeLog" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
            "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver"
          }
        },
        "zh_CN" : {
          "addon" : {
            "changeLog" : "",
            "description" : ""
          }
        }
      },
      "supportVersions" : null,
      "creationTimestamp" : "2018-10-23T13:14:55Z",
      "updateTimestamp" : "2018-12-07T09:40:24Z"
    }
  }
}

Códigos de status

Código de status

Descrição

200

OK

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de complementos