Usando os comandos site

É possível usar os comandos site para verificar o site no serviço Portal do Desenvolvedor e para exportar e importar uma configuração de site inteira.

Sobre

É possível usar os comandos site para verificar o funcionamento de um site do portal, reconstruir o cache de um site e exibir o link de login para uma conta de administrador de um local. Também é possível usá-las para exportar as definições de configuração para um site inteiro do Portal do Desenvolvedor e importar essas configurações para outro site Por exemplo, você poderia usar os comandos de exportação e importação para replicar a configuração de um site de teste em um site de produção

Importante: Se você desejar importar um arquivo de configuração de exportação de site, o arquivo de exportação deverá ter sido criado na mesma versão do API Connect que a versão para a qual você deseja importar..

Efetue login como organização do Provedor:
```
apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_password
```
É possível determinar qual provedor de identidade usar no parâmetro --realm inserindo o comando a seguir para ver uma lista de todos os provedores de identidade disponíveis (não é necessário estar conectado para usar este comando):
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm
```
Por exemplo,
```
apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
total_results: 2
results:
  - title: API Manager User Registry
    realm: provider/default-idp-2
  - title: Corporate LDAP user registry
    realm: provider/corporate-ldap
```
O valor title deve permitir que você determine qual provedor de identidade usar; será possível, então, copiar o parâmetro --realm correspondente diretamente do valor realm exibido. Para todos os provedores de identidade que o administrador criou após a instalação do API Connect , os nomes são determinados no momento da criação. O Registro do usuário local do API Manager padrão para efetuar login como um membro de uma organização do provedor é default-idp-2.
Para obter detalhes completos do comando apic login , consulte Efetuando login em um servidor de gerenciamento..

Para obter um resumo dos comandos de propósito geral e de seu uso, consulte Comandos da CLI do Portal do Desenvolvedor
Verifique o site em seu serviço do portal Esse comando verifica o sistema de arquivos, o banco de dados e o API Manager no site do portal, que pode identificar problemas relacionados à plataforma no site do portal.
```
apic --mode portaladmin site:check  --server management_server --catalog catalogid/name --org orgid/name --format format_type
```
- management_server é o URL do ponto de extremidade do servidor de gerenciamento (obrigatório).
- catalogid/name é o ID ou nome do catálogo ao qual o site pertence (obrigatório).
- orgid/name é o ID ou o nome da organização do provedor à qual o catálogo pertence (obrigatório)
- format_type é o formato de saída.. Pode ser json, yaml, go-template=..., go-template-file=.... O padrão é yaml.

Reconstrua o cache de um site do portal específico.

apic --mode portaladmin site:cache-rebuild  --server management_server --catalog catalogid/name --org orgid/name

Por exemplo:

apic --mode portaladmin site:cache-rebuild --server management_server --org ibm --catalog portal-test
[success] Cache rebuild complete.

Exibir o estado de um site do portal associado a uma organização e catálogo específicos. Esse comando é útil como uma verificação de funcionamento geral do site

apic --mode portaladmin site:state --server management_server --catalog catalogid/name --org orgid/name --format format_type

apic --mode portaladmin site:state --server my.management.server.com --org ibm --catalog portal-test --format json
{
    "alias": "ibm.portal-test.my.management.server.com",
    "check_state": "OK: 200",
    "content_refresh_required": false,
    "known_to_apim": 1,
    "platform": "platform_devportal_9_x_10_99_99_99_20210922_2000",
    "snapshot_first_requested": "0000-00-00 00:00:00",
    "snapshots_failed_processing_since_last_success": 0,
    "snapshots_requested_since_last_received": 0,
    "state": "INSTALLED",
    "subscribed_to_webhooks": true,
    "url": "my.management.server.com/ibm/portal-test",
    "uuid": "cc0ad766-e372-4988-9d45-744eb8d381de.1cd9dc41-b08d-xyz"
}

Efetue login em seu administrador do Portal do Desenvolvedor com um link. Esse comando exibe um link de login único para a conta do administrador para seu site Portal do Desenvolvedor que é especificado pelo catálogo e pela organização.

 apic --mode portaladmin site:login-link  --server management_server --org ibm --catalog portal-test
sample output:
https://my.portal.server.com/ibm/portal-test/user/reset/1/12345678901/ABCde1f2gH3ijKL-4M_NOPqrs5TU6VWxy7ZABCDEFg7h8/new/login

Exporte a configuração de seu site inteiro usando o comando site:create-export a seguir: Esse comando cria uma tarefa de exportação que retorna um arquivo .tgz que contém a configuração do site Por padrão, o comando pesquisa o status da tarefa a cada 10 segundos até que a tarefa seja concluída, nesse ponto o arquivo de exportação é retornado. Observe que a exportação de toda a configuração do site pode levar muito tempo para ser concluída.
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:create-export
```
Em que:
- --no-poll é uma sinalização opcional que significa que o comando não pesquisará o status da tarefa, mas, em vez disso, apenas retornará o ID da tarefa. Esse ID da tarefa pode ser usado com o comando site:get-export para retornar o arquivo de exportação.
Nota: O comando continua pesquisando até que o tempo máximo de pesquisa de 15 minutos seja atingido. Nesse ponto, é possível utilizar os comandos site:get_export_status e site:get-export para obter o status e, se a tarefa tiver sido concluída, um artefato
Por exemplo:
```
apic --mode portaladmin --server my_management_server --org my_org --catalog my_catalog site:create-export
201 CREATED - Task ID: vfg6b8utjtw51

Response Code - 202:

Message(s) - 
The status of this task is: QUEUED

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 200:

Message(s) -
The status of this task is: FINISHED and the artifact can now be streamed

Saving File (Large files may take a while)...
Incoming project saved to site_createExport-20231013154023.tgz
```
O comando salva o arquivo de exportação em seu diretório de execução O arquivo .tgz de exportação inclui um arquivo site-content.tgz e um arquivo site-config.tgz . O arquivo de exportação também incluirá um arquivo site-custom-themes.tgzou um arquivo site-custom-modules.tgz ou ambos, dependendo se o site contiver quaisquer temas customizados ou módulos customizados.
Se você executou o comando site:create-export com a opção --no-poll , será possível usar os seguintes comandos para gerenciar a exportação do site.
- site:delete-export
  Cancela quaisquer tarefas do site:create-export atualmente em execução e exclui quaisquer artefatos relacionados Por exemplo:
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:delete-export --task_id task_id
```
  Em que task_id é o ID da tarefa de exportação na fila.
- site:get-export
  Transmite o conteúdo de uma tarefa de exportação concluída específica para um arquivo .tgz . Por exemplo:
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:get-export --task_id task_id
```
- site:get-export-status
  Retorna o status de uma tarefa de exportação específica Por exemplo:
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:get-export-status --task_id task_id
```

Importe a configuração de seu site usando o comando site:create-import Esse comando ativa uma tarefa de pesquisa de importação que pesquisa o status da tarefa a cada 10 segundos até que a tarefa seja concluída, no ponto em que um resumo da importação é retornado Se o comando for executado com a opção --no-poll , a tarefa não retorna o status da tarefa, mas apenas retorna o ID da tarefa.

Importante:

Se você quiser importar um arquivo de configuração de exportação de site, o arquivo de exportação deverá ter sido criado na mesma versão do site API Connect que a versão para a qual você deseja importar.
O comando site:create-import altera as IDs de termos de taxonomia. Isso pode afetar as configurações que fazem referência a IDs específicos. Como os IDs não são preservados como parte da importação ou exportação, é necessário revisar e ajustar essas configurações após a importação para garantir que funcionem corretamente.

apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:create-import export_file_name

Em que:

export_file_name é o nome do arquivo de exportação que você deseja importar É possível importar arquivos .tgz que foram criados usando o comando site:create-export ..
--no-poll é uma sinalização opcional que significa que o comando não pesquisará o status da tarefa, mas, em vez disso, apenas retornará o ID da tarefa. Esse ID de tarefa pode ser usado com o comando site:get-import-status para obter o status da tarefa.

Nota: O comando continua pesquisando até que o tempo máximo de pesquisa de 15 minutos seja atingido. Nesse ponto, é possível usar o comando site:get-import-status para obter o status da tarefa

No exemplo a seguir, o arquivo de exportação da Etapa 6 é importado para um site de produção do Portal do Desenvolvedor em um servidor diferente:

apic --mode portaladmin --server my_management_server2 --org my_prod_org --catalog my_prod_catalog site:create-import site_createExport-20231013154023.tgz
Loading File (Large files may take a while)...

201 CREATED - Task ID: 1z8e9zthfkhwdxh2

Response Code - 202:

Message(s) - 
The status of this task is: QUEUED

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 202:

Message(s) - 
The status of this task is: RUNNING

Response Code - 200:

Message(s) - 
2023-10-11 10:50:05: CLI task (site:import) starting.
2023-10-11 10:50:08: Performing a whole site import
2023-10-11 10:50:08: 1. Importing Site's Configuration
2023-10-11 10:50:41: 2. Importing Site's Content
2023-10-11 10:51:30: [notice] [1/30] - [node.page:1] "Terms of use" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/tsandcs)
 [notice] [2/30] - [node.page:2] "Privacy Policy" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/privacy)
 [notice] [3/30] - [node.faq:3] "Using our APIs" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/node/3)
 [notice] [4/30] - [node.faq:4] "Apps" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/node/4)
 [notice] [5/30] - [node.page:5] "AsyncAPI" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/asyncapi)
 [notice] [6/30] - [node.page:6] "Kafka" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/asyncapi-kafka)
 [notice] [7/30] - [node.page:7] "MQ" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/asyncapi-mq)
 [notice] [8/30] - [node.article:17] "This is an article" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/node/17)
 [notice] [9/30] - [node.article:20] "article 2" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/node/20)
 [notice] [10/30] - [node.page:23] "Basic page 1" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/node/23)
 [notice] [11/30] - [block_content.basic:1] "No Apps Found [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/1)
 [notice] [12/30] - [block_content.basic:2] "No Apis Found [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/2)
 [notice] [13/30] - [block_content.basic:3] "No Products Found [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/3)
 [notice] [14/30] - [block_content.basic:4] "No Blogs Found [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/4)
 [notice] [15/30] - [block_content.basic:5] "Welcome Banner [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/5)
 [notice] [16/30] - [block_content.basic:6] "Getting Started [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/6)
 [notice] [17/30] - [block_content.basic:7] "Get Help [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/7)
 [notice] [18/30] - [block_content.basic:8] "Forum Sidebar [en]" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/content/block/8)
 [notice] [19/30] - [menu_link_content:1] "Home" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/1/edit)
 [notice] [20/30] - [menu_link_content:2] "API Products" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/2/edit)
 [notice] [21/30] - [menu_link_content:3] "Apps" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/3/edit)
 [notice] [22/30] - [menu_link_content:4] "Forums" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/4/edit)
 [notice] [23/30] - [menu_link_content:5] "Sign in" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/5/edit)
 [notice] [24/30] - [menu_link_content:6] "Create account" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/6/edit)
 [notice] [25/30] - [menu_link_content:7] "Contact" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/7/edit)
 [notice] [26/30] - [menu_link_content:8] "Terms and Conditions" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/8/edit)
 [notice] [27/30] - [menu_link_content:9] "Privacy Policy" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/structure/menu/item/9/edit)
 [notice] [28/30] - [shortcut.default:1] "Add content" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/config/user-interface/shortcut/link/1)
 [notice] [29/30] - [shortcut.default:2] "All content" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/admin/config/user-interface/shortcut/link/2)
 [notice] [30/30] - [taxonomy_term.forums:1] "General discussion" - Updated (https://portal.ibm.com/apim-portal-org2/test-google/taxonomy/term/1)
2023-10-11 10:52:38: CLI task (site:import) completed successfully.

A seção de mensagem fornece informações detalhadas sobre a importação conforme a configuração está sendo importada.

Se você executou o comando site:create-import com a opção --no-poll , será possível usar os comandos a seguir para gerenciar a importação de conteúdo
- site:delete-import
  Cancela quaisquer tarefas do site:create-import atualmente em execução e exclui quaisquer artefatos relacionados Por exemplo:
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:delete-import --task_id task_id
```
  Em que task_id é o ID da tarefa de importação na fila.
- site:get-import-status
  Retorna o status de uma tarefa de importação específica Por exemplo:
```
apic --mode portaladmin --server management_server --org orgid/name --catalog catalogid/name site:get-import-status --task_id task_id
```