Gerenciar implantações

Esta página se aplica à Apigee e à Apigee híbrida.

Neste documento, descrevemos como criar e gerenciar implantações de API. Consulte também Introdução às implantações de API. Depois de criar uma entidade de implantação, é possível vinculá-la a uma ou mais versões da API.

Criar uma implantação

É possível criar uma entidade de implantação no console ou com a API REST.

Console

Para criar uma implantação:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Na guia Implantações, clique em Adicionar implantação.
  6. Especifique os detalhes no formulário Criar implantação:
    • ID da implantação: clique em Especificar ID exclusivo para fornecer, se quiser, um ID exclusivo para a implantação. Se você omitir o ID, o hub de APIs criará um por você. O ID precisa ter de 4 a 500 caracteres, e os caracteres válidos são /[A-Z][a-z][0-9]-/.
    • Nome da implantação: (obrigatório) forneça um nome de exibição para a implantação.
    • Descrição: escreva uma descrição da implantação.
    • Tipo de implantação: selecione o tipo de implantação. Os valores possíveis são definidos em um atributo do sistema e podem ser modificados em Gerenciar atributos.
    • URI do recurso: (obrigatório) forneça um URI para o recurso de ambiente de execução. Esse URI pode ser usado para gerenciar o recurso. Por exemplo, se o recurso de ambiente de execução for um proxy da API Apigee, esse campo precisará especificar o URI para a interface do usuário de gerenciamento do proxy.
    • Ambiente: o mapeamento do ambiente com essa implantação. O ambiente é mapeado com o atributo de ambiente definido pelo sistema.
    • Documentação: insira um link para a documentação da implantação.
    • SLO: forneça o SLO dessa implantação. Isso é mapeado com o atributo definido pelo sistema do SLO. É possível modificar os valores desse atributo em Gerenciar atributos.
    • Endpoints: (obrigatório) forneça os endpoints em que o recurso de implantação detecta solicitações de API. Pode ser uma lista de URIs, nomes dos hosts ou endereços IP completos.
    • Vincular a uma versão: vincule a implantação a uma ou mais versões da API.
    • Atributos definidos pelo usuário: pares de chave-valor definidos pelo usuário. É possível adicionar atributos definidos pelo usuário em Gerenciar atributos.
  7. Clique em Criar.

REST

Para adicionar uma nova implantação usando a API Create a deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • DEPLOYMENT_ID (opcional): o identificador da implantação. Caso não seja informado, um ID gerado pelo sistema será usado. O nome precisa ser uma string de 4 a 500 caracteres, em que os caracteres válidos são /[a-z][A-Z][0-9]-_/.
  • DISPLAY_NAME: (obrigatório) o nome de exibição da implantação. Use o nome que preferir.
  • Atributos opcionais: além do nome de exibição obrigatório, é possível anexar atributos e entidades opcionais a uma implantação. Esses itens adicionais são descritos na descrição de recursos de implantação, na Referência da API REST.

Vincular uma implantação a uma versão da API

Uma versão pode ter uma ou mais implantações vinculadas a ela. Nesta seção, explicamos como vincular implantações a versões. É possível vincular implantações a uma versão no momento da criação dela ou vincular implantações a uma versão existente ao editá-la. Consulte Criar uma versão da API e Editar uma versão.

Para vincular uma implantação a uma versão nova ou existente, é necessário que a implantação já exista. Consulte Criar uma implantação.

Console

Para adicionar uma implantação a uma versão:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Selecionar uma API.
  5. Na tabela Versões, localize a versão que você quer editar.
  6. Selecione Editar no menu "Ações", no lado direito da linha da versão, ou selecione a versão e clique em Editar versão na página de detalhes.
  7. Em Vincular a uma implantação, selecione uma ou mais implantações para vincular à versão e clique em Ok.
  8. Clique em Salvar.

REST

Exemplo de como adicionar uma implantação a uma versão:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • API_NAME: o nome da API com a versão que você quer editar.
  • VERSION_ID: o ID exclusivo da versão a ser editada.
  • DEPLOYMENTS: o nome totalmente qualificado do recurso de uma ou mais implantações. Exemplo: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Listar implantações

Esta seção explica como listar as implantações. É possível listar todas as implantações associadas a todas as versões de uma API ou listar todas as implantações associadas a uma versão específica.

Console

Para listar implantações com a IU:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecione a guia Implantações para listar todas as implantações associadas à API.
  6. Na guia Versões, selecione uma versão para ver as implantações associadas a ela.

REST

Para listar todas as implantações, use a API List deployments:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.

Receber detalhes da implantação

Esta seção explica como conseguir os detalhes de uma implantação de API.

Console

Para consultar os detalhes de uma implantação, faça isto:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecione a guia Implantações para listar todas as implantações associadas à API.
  6. Selecione a implantação para ver a página de detalhes dela.

REST

Para ver os detalhes de uma implantação, use a API Get deployment details:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • DEPLOYMENT_ID: o ID exclusivo da implantação.

Excluir uma implantação de API de uma API

Nesta seção, explicamos como excluir a implantação de API. Quando você exclui uma implantação de API de uma API, ela é desvinculada de todas as versões da API e, em seguida, é excluída da API. Depois que uma implantação é excluída, ela não aparece mais na lista de implantações, e não é mais possível filtrar as APIs com base na implantação excluída.

Console

Para excluir uma implantação usando a interface:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecione a guia Implantações para listar todas as implantações associadas à API.
  6. Localize a implantação que você quer excluir.
  7. Selecione Excluir no menu Ação da implantação.

REST

Para excluir uma implantação no hub de APIs, use a API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • DEPLOYMENT_ID: o ID exclusivo da implantação a ser excluída.

Desvincular uma implantação de API de uma API ou versão

Esta seção explica como desvincular uma implantação de API de uma API ou versão. Se você desvincular uma implantação de uma API, ela será desvinculada de todas as versões dessa API. Quando a desvinculação é feita, a implantação não aparece mais na lista de implantações.

Console

Para desvincular uma implantação de uma API usando a interface:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecione a guia Implantações para listar todas as implantações associadas à API.
  6. Localize a implantação que você quer desvincular.
  7. Selecione Desvincular da API no menu Ação da implantação.

Para desvincular uma implantação de uma versão usando a interface:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecionar uma versão
  6. Na seção Implantações, localize a implantação que você quer desvincular.
  7. Selecione Desvincular da versão no menu Ação da implantação.

REST

Para excluir um recurso de API do hub de APIs, use a API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • DEPLOYMENT_ID: o ID exclusivo da implantação a ser excluída.

Editar uma implantação

Nesta seção, explicamos como editar uma implantação.

Console

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API
  2. Clique em APIs.
  3. Use Filtro para especificar palavras-chave e filtrar a lista de APIs. Se necessário, use a Pesquisa para localizar uma API.
  4. Clique em uma API para conferir os detalhes.
  5. Selecione a guia Implantações para listar todas as implantações associadas à API.
  6. Localize a implantação que você quer editar.
  7. Selecione Editar no menu Ação da implantação ou clique nela e depois em Editar implantação no painel Detalhes da implantação.

REST

Para editar uma implantação, use a API Patch deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

Substitua:

  • HUB_PROJECT: o nome do projeto host do hub da API. O projeto host foi selecionado quando o hub de API foi provisionado.
  • HUB_LOCATION: o local do projeto host. O local foi escolhido quando o hub da API foi provisionado.
  • DEPLOYMENT_ID: o ID exclusivo da implantação a ser editada.
  • DEPLOYMENT_ATTRIBUTES: anexe os atributos que você quer modificar no corpo da solicitação. Os atributos editáveis são descritos na descrição de recursos de implantação, na Referência da API REST.