Exportadores padrão Configuração de DevOps

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 6 min. de leitura
  • O pacote de conteúdo do exportador Configuração de DevOps contém um conjunto de exportadores Configuração de DevOps padrão de dados que podem ser usados como entrada para outras atividades de implantação e provisionamento.

    Importante:
    A partir da versão Washington DC, o Configuração de DevOps está sendo preparado para descontinuação futura. Ele ficará oculto e não será mais instalado em novas instâncias, mas continuará sendo compatível. Para obter detalhes, consulte o artigo Deprecation Process (Processo de descontinuação) [KB0867184] na Base de conhecimento do Now Support.

    Configuração de DevOps Os exportadores permitem que outras ferramentas consumam os dados de snapshots implantáveis.

    Nota:
    Não é possível modificar exportadores padrão. No entanto, você pode fazer uma cópia do exportador e personalizar sua cópia.
    Esses exportadores estão contidos no pacote de conteúdo do exportador Configuração de DevOps.
    • retornaTodosDados-agora
    • retornaTodosDados_semVars-agora
    • retornarDadosparaNomeNode-now
    • retornarDataForNodeNames-now
    • retornaDadosParaPath-now
    • retornaNodeListForLevel-now
    • retornaNodeListForPath-now
    • retornarValueForKeyAtNodeName-now
    • retornarValueForKeyPath-now
    • retornarValueForUniqueKeyName-now

    Retornar todos os dados (returnAllData-now)

    Retorna o conteúdo completo do snapshot sem qualquer filtragem ou modificação, incluindo a pasta do sistema var.
    Nota:
    O exportador falhará se a aplicação/implantável não estiver no estado Ativo (excluído).
    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    Lógica especial
    Nenhum.
    Tratamento de erros
    Nenhum.

    Retornar todos os dados, exceto variáveis (returnAllData_noVars-now)

    Retorna todos os dados de configuração do implantável, exceto o nome e as variáveis do implantável.

    A resposta não inclui:
    • Pastade variáveis no nível do implantável
    • pastade variáveis em cada uma das coleções incluídas
    • Nome do implantável no nível raiz da resposta
    Nota:
    Este exportador não funciona para aplicações/implantáveis excluídos.
    Argumentos
    Argumentos (podem ser fornecidos na linha de comando ou inseridos interativamente no modo de execução).
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    Lógica especial
    Nenhum.
    Tratamento de erros
    Nenhum.

    Retornar dados para um nome de nó (returnDataforNodeName-now)

    Retorna o subconjunto dos dados do snapshot para um determinado nome de nó, que é fornecido como um argumento. O valor do argumento deve ser passado como texto de cadeia de caracteres.

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • nodeName — Nome do nó (cadeia de caracteres, entre aspas)
    • includeNodeInOutput - (cadeia de caracteres, o padrão é verdadeiro)
    Lógica especial
    • Se nodeName estiver vazio, todos os dados serão retornados.
    • Se includeNodeInOutput for falso, os dados do nó serão retornados, excluindo o nome do nó.
    Tratamento de erros
    • Se o nodeName não for exclusivo, várias instâncias de nodeName foram encontradas.
    • Se o nodeName não for encontrado, o nó não foi encontrado:<nodeName> .
    • Se includeNodeInOutput for falso e os dados do nó forem um par de chave-valor, será retornado um erro.

    Retornar dados para a lista de nós (returnDataForNodeNames-now)

    Retorna os dados completos do snapshot para uma lista de nós. Igual a Retornar dados para um nome de nó, mas retorna um JSON aninhado com dados de configuração para uma lista de nomes de nó fornecidos (incluindo todos os nós secundários).

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • nodeNames — Nomes do nó (cadeia de caracteres, entre aspas, separado por vírgula)
    Lógica especial
    Se nodeNamesList estiver vazio, retornará todos os dados de configuração.
    Tratamento de erros
    Nenhum.
    Detalhes da resposta
    {"node1":{"contentKey":"contentValue"},"node2":{ "error":"nodeName not opened"}}.
    Tratamento de erros
    • Caso o nodeName não seja exclusivo, o exportador retornará uma resposta de erro informando "várias instâncias de nodeName encontradas" para esse nodeName específico. Outros nodeNames contêm os dados
    • Se um nodeName não for encontrado, ele deverá conter uma mensagem de erro para esse nó

    Retornar dados para o caminho (returnDataForPath-now)

    Retorna todos os dados de configuração para um determinado caminho de nó no snapshot.

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • nodePath — Caminho do nó (cadeia de caracteres, entre aspas)
    Lógica especial
    Se nodePath estiver vazio, retorna todo o conteúdo (semelhante a todos os dados de configuração).
    Tratamento de erros
    Se nodePath não for encontrado, o último nome de nó que não foi encontrado será o caminho declarado não encontrado:<nodeName> .

    Retornar lista de nós para nível (returnNodeListForLevel-now)

    Retorna uma lista de nomes de nós que são secundários do nó raiz no nível especificado (profundidade) no snapshot. Por exemplo, o nível 1 é um secundário direto do nó raiz, o nível 2 é um neto etc.

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [true|false] - Exclui o nó de variáveis do resultado (verdadeiro ou falso, o padrão é verdadeiro)
    • nodeLevel — Nível do nó (inteiro, o padrão é 0)
    Lógica especial
    Se nenhum nível for especificado, o exportador retornará o valor do nível 0 (por exemplo, o nome do nó raiz implantável).
    Tratamento de erros
    Nenhum.
    Detalhes da resposta
    ["node1, "node2", "node3"]

    Retornar lista de nós para o caminho (returnNodeListForPath-now)

    Retorna a lista de nós para um determinado caminho de nó no snapshot (sem levar em conta os subnós).

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [true|false] - Exclui o nó de variáveis do resultado (verdadeiro ou falso, o padrão é verdadeiro)
    • nodePath — Caminho a ser seguido com lista de nós separados por pathSeparator (cadeia de caracteres, entre aspas)
    • pathSeparator — Caractere para separar a lista de nodePaths (cadeia de caracteres, o padrão é ',')
    Lógica especial
    Nenhum.
    Tratamento de erros
    Nenhum.
    Detalhes da resposta
    ["node1, "node2", "node3"]

    Retornar valor para chave em um nó (returnValueForKeyAtNodeName-now)

    Retorna o valor de uma chave específica que faz parte de um nó no snapshot. A chave pode ser definida diretamente para o nó ou inferior no modelo de dados para um dos secundários do nó.

    A diferença entre este exportador e o valor de exportação para keyName exclusivo é que o nome da chave só precisa ser exclusivo na subárvore do nó.

    Espera-se que a combinação de chave/nó seja exclusiva no snapshot. Se a combinação de chave/nó for encontrada mais de uma vez, há um erro.

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • keyName — Nome da chave (cadeia de caracteres, entre aspas)
    • nodeName — Nome do nó (cadeia de caracteres, entre aspas)
    Lógica especial
    Nenhum.
    Manipulação de erros
    Se a combinação keyName nodeName não for encontrada, uma resposta vazia será retornada.

    Valor de retorno para keyPath (returnValueForKeyPath-now)

    Retorna o valor de uma chave específica em um caminho específico.

    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/xml/ini/raw)
    • keyPath — Lista de nomes de nós com o nome da chave no final separados por pathSeparator (cadeia de caracteres, entre aspas)
    • pathSeparator — Caractere para separar a lista de keyPaths (cadeia de caracteres, o padrão é ',')
    Lógica especial
    Nenhum.
    Tratamento de erros
    • Se o keyPath não for fornecido, nenhum argumento keyPath será fornecido.
    • Se o keyPath não for encontrado, informará que o último nome de nó não encontrado caminho não encontrado:<path> /<nodeName> .
    • Se o keyPath for encontrado e for um nó (não uma chave), o keyPath fornecido será um nó e não uma chave.

    Valor de retorno para keyName exclusivo (returnValueForUniqueKeyName-now)

    Retorna o valor de uma chave específica com base em seu nome no snapshot. Ao contrário do valor de exportação da chave em um nó, espera-se que a chave seja exclusiva no modelo de dados do snapshot. Várias chaves são compatíveis.
    Nota:
    Os formatos xml e ini não são compatíveis com este exportador.
    Argumentos
    • appName — Nome da aplicação
    • deployableName — Nome do implantável
    • requestFormat — Formato solicitado (json/yaml/raw)
    • keyName — Nome da chave (matriz de dados)
    Lógica especial
    Se a chave estiver presente várias vezes no snapshot, o exportador retornará o primeiro valor encontrado (retorna erro).
    Tratamento de erros
    • Se o keyName não for fornecido, nenhum argumento keyName será fornecido.
    • Se a chave não for encontrada, a chave não foi encontrada:<keyName> .