Passo 4: crie uma organização

Criou uma conta e um projeto do Google Cloud e ativou as APIs. Agora, pode criar a sua organização.

Pré-requisito

Para criar uma organização, tem de cumprir uma das seguintes condições:

• Ter uma conta de avaliação. As contas de avaliação expiram após 60 dias. Nessa altura, a organização vai ser eliminada.
• Ter uma conta paga

Se nenhuma destas opções for verdadeira, tem de contactar as vendas do Apigee antes de poder continuar.

Para criar uma nova organização e aprovisioná-la:

1. Na linha de comandos, obtenha as suas credenciais de autenticação gcloud, como mostra o exemplo seguinte:

   TOKEN=$(gcloud auth print-access-token)

   Para verificar se o token foi preenchido, use echo, como mostra o exemplo seguinte:

   echo $TOKEN

   Esta ação deve apresentar o seu token como uma string codificada.

   Para mais informações, consulte a vista geral da ferramenta de linhas de comando gcloud.

2. Crie as seguintes variáveis de ambiente para os elementos da organização. Vai usá-los no comando para criar a organização.
   • PROJECT_ID (Obrigatório) é o projeto do Google Cloud que quer associado à sua nova organização com capacidade híbrida. Este é o ID que a Google gerou para si no passo 2: crie um projeto do Google Cloud.

     export PROJECT_ID=your_project_id

     

   • ORG_NAME (Obrigatório) é o ID programático que quer para a sua organização com a funcionalidade híbrida ativada.

     export ORG_NAME=$PROJECT_ID

   • ORG_DISPLAY_NAME (Opcional) é o nome simples da sua organização. Este valor não tem de ser exclusivo e pode incluir espaços e carateres especiais. Por exemplo, "A minha organização híbrida".

     ORG_DISPLAY_NAME="friendly_name"

     Os conteúdos dos nomes das variáveis que contêm espaços têm de estar entre aspas duplas. Por exemplo: "A minha organização"

   • ORGANIZATION_DESCRIPTION (Opcional) são informações sobre a organização que quer usar como lembrete da respetiva finalidade. Por exemplo, "A minha primeira organização".

     ORGANIZATION_DESCRIPTION="description_text"

   • ANALYTICS_REGION (Obrigatório) é a região principal para o armazenamento de dados de estatísticas.

     export ANALYTICS_REGION=analytics_region

     Em que analytics_region é uma das seguintes opções:

     asia-northeast1	asia-south1	australia-southeast1
     us-central1	us-east1	us-west1
     europe-west2	europe-west1

     Escolha uma região geograficamente próxima ou que satisfaça os requisitos de armazenamento da sua organização.

   • RUNTIMETYPE (Obrigatório) é o tipo de tempo de execução da organização do Apigee, em que HYBRID é o tempo de execução híbrido do Apigee gerido pelo utilizador.

     export RUNTIMETYPE=HYBRID

3. Envie um pedido POST autenticado para a API Create organizations.

   O exemplo seguinte mostra a estrutura do pedido que cria uma organização:

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
     -d '{
       "name":"'"$ORG_NAME"'",
       "displayName":"'"$ORG_DISPLAY_NAME"'",
       "description":"'"$ORGANIZATION_DESCRIPTION"'",
       "runtimeType":"'"$RUNTIMETYPE"'",
       "analyticsRegion":"'"$ANALYTICS_REGION"'"
     }' \
     "https://apigee.googleapis.com/v1/organizations?parent=projects/$PROJECT_ID"

   Num pedido de criação bem-sucedido, a API Organizations deve responder com uma mensagem semelhante à seguinte:

   {
     "name": "organizations/org_name/operations/long_running_operation_ID",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
       "operationType": "INSERT",
       "targetResourceName": "organizations/org_name",
       "state": "IN_PROGRESS"
     }
   }

   Onde:

   • long_running_operation_ID é o UUID de uma operação assíncrona de longa duração. Pode usar este ID para verificar o estado do seu pedido de criação da organização (descrito no passo 5).
   • org_name é o ID da sua nova organização que está atualmente a ser criada.

   Como a propriedade state na resposta indica, o Apigee começou a criar a nova organização, pelo que o respetivo estado é IN_PROGRESS. Este processo pode demorar vários minutos.

   Se receber um erro, consulte o artigo Resolução de problemas de criação de organizações.

4. Guarde o ID da operação de longa duração numa variável de ambiente. Vai ser útil para tarefas de gestão futuras.

   Sintaxe

   export LONG_RUNNING_OPERATION_ID=long_running_operation_ID

   Exemplo

   export LONG_RUNNING_OPERATION_ID=6abc8a72-46de-f9da-bcfe-70d9ab347e4f

5. Pode verificar o estado da operação de longa duração cujo ID o Apigee devolveu no seu pedido de criação inicial. Para o fazer, use a API Operations. Por exemplo:

   curl -H "Authorization: Bearer $TOKEN" \
     "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/operations/$LONG_RUNNING_OPERATION_ID"

   Os exemplos seguintes mostram possíveis respostas a este pedido:

   IN_PROGRESS

   Se o Apigee ainda estiver a criar a organização, o Apigee responde com o estado IN_PROGRESS. Por exemplo:

   {
       "name": "organizations/org_name/operations/long_running_operation_ID",
       "metadata": {
         "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
         "operationType": "INSERT",
         "targetResourceName": "organizations/org_name",
         "state": "IN_PROGRESS"
       }
     }

   Deve aguardar um pouco mais antes de tentar validar se o processo de criação está concluído.

   CONCLUÍDO

   Quando a organização tiver sido aprovisionada, o estado da operação de longa duração é FINISHED. Por exemplo:

   {
     "name": "organizations/org_name/operations/long_running_operation_ID",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
       "operationType": "INSERT",
       "targetResourceName": "organizations/org_name",
       "state": "FINISHED"
     },
     "done": true,
     "response": {
       "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization",
       "name": "org_name",
       "displayName": "display_name",
       "description": "description",
       "createdAt": "1600817805771",
       "lastModifiedAt": "1600817805771",
       "properties": {
         "property": [
           {
             "name": "features.hybrid.enabled",
             "value": "true"
           },
           {
             "name": "features.mart.connect.enabled",
             "value": "true"
           }
         ]
       },
       "analyticsRegion": "us-central1",
       "runtimeType": "HYBRID",
       "subscriptionType": "TRIAL"
     }
   }

   Se não introduziu uma descrição, esse campo não aparece na resposta.

Veja os detalhes da organização

Pode ver os detalhes dos metadados da organização que criou através de uma API Apigee. Também pode usar uma API para listar todas as organizações às quais a sua conta do Google Cloud tem acesso. Para realizar estas ações, usa a API organizations.

Antes de experimentar as APIs, atualize o token de autorização:

TOKEN=$(gcloud auth print-access-token)

https://apigee.googleapis.com/v1/organizations/org_name

curl -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/hybrid-example"

{
  "name": "organizations/org_name/operations/long_running_operation_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "INSERT",
    "targetResourceName": "org_name",
    "state": "FINISHED"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization",
    "name": "org_name",
    "displayName": "display_name",
    "description": "description",
    "createdAt": "1600817805771",
    "lastModifiedAt": "1600817805771",
    "properties": {
      "property": [
        {
          "name": "features.hybrid.enabled",
          "value": "true"
        },
        {
          "name": "features.mart.connect.enabled",
          "value": "true"
        }
      ]
    },
    "analyticsRegion": "us-central1",
    "runtimeType": "HYBRID",
    "subscriptionType": "TRIAL"
  }
}

https://apigee.googleapis.com/v1/organizations

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations"

{
  "organizations": [
    {
      "organization": "hybrid-example",
      "projectIds": [
        "hybrid-example"
      ]
    }
  ]
}

Resolução de problemas de criação da organização

Quando cria uma organização com a API Create organizations, pode receber uma resposta de erro. As respostas têm o seguinte aspeto:

{
  "error": {
    "code": HTTP_error_code,
    "message": "short_error_message",
    "status": "high_level_error_type",
    "details": [
      {
        "@type": "specific_error_type",
        "detail": "expanded_error_description"
      }
    ]
  }
}

O exemplo seguinte mostra uma resposta a um erro comum: o ID da organização contém carateres ilegais (não são permitidos carateres em maiúsculas nos IDs das organizações):

{
  "error": {
    "code": 400,
    "message": "invalid Organization ID \"MY-ORG\": \"MY-ORG\" is an invalid Organization ID",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "",
        "detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID \"MY-ORG\":
          \"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext]
          { message: \"invalid Organization ID \\\"MY-ORG\\\": \\\"MY-ORG\\\" is an invalid
          Organization ID\" }"
      }
    ]
  }
}

Neste caso, pode mudar o nome da organização para letras minúsculas e reenviar o pedido.

A tabela seguinte apresenta os erros que pode receber e as potenciais resoluções quando tenta criar uma nova organização: