Primeiros passos

Introdução

Esta seção descreve como chamar uma API para registrar uma API HTTP.

Para obter detalhes sobre como chamar APIs, consulte Chamar APIs.

Procedimento

1. Chame a API mencionada em Criação de um grupo de API para criar um grupo de API.
2. Chame a API mencionada em Registro de uma API para registrar uma API HTTP.

Registrar uma API HTTP

1. Chame a API mencionada em Criação de um grupo de API para criar um grupo de API.

   {
   	"name": "APIGroup_test",
   	"remark": "Test group"
   }

   Especifique os seguintes parâmetros:

   • name: nome do grupo de API
   • remark: descrição do grupo de API

2. Chame a API de registro da API para registrar uma API HTTP. Para obter detalhes, consulte Registro de uma API.

   {
   	"auth_type": "APP",
   	"backend_api": {
   		"req_method": "GET",
   		"req_protocol": "HTTP",
   		"req_uri": "/test/benchmark",
   		"timeout": 1000,
   		"url_domain": "xx.xx.xx.93:12346"
   	},
   	"backend_type": "HTTP",
   	"group_id": "2b89e73458******98a828c5eca3b6c3",
   	"name": "test",
   	"req_method": "GET",
   	"req_uri": "/test",
   	"type": 1,
   	"result_normal_sample": "hello world!"
   }

   Especifique os seguintes parâmetros:

   • auth_type: modo de autenticação de segurança da API
   • backend_api: parâmetros de serviço de back-end
     • req_method: método de solicitação da API
     • req_protocol: protocolo de solicitação do serviço de back-end
     • req_uri: caminho de solicitação do serviço de back-end
     • timeout: intervalo de tempo limite permitido para o APIG solicitar o serviço de back-end
     • url_domain: endereço do serviço de back-end
       

       Os seguintes segmentos de endereços IP reservados não podem ser usados:

       • 0.0.0.0/8
       • 10.0.0.0/8
       • 100.125.0.0/16
       • 127.0.0.0/8
       • 169.254.0.0/16
       • 172.16.0.0/12
       • 192.0.0.0/24
       • 192.0.2.0/24
       • 192.88.99.0/24
       • 192.168.0.0/16
       • 198.18.0.0/15
       • 198.51.100.0/24
       • 203.0.113.0/24
       • 224.0.0.0/4
       • 240.0.0.0/4
       • 255.255.255.255/32
   • backend_type: tipo do serviço de back-end
   • group_id: ID do grupo ao qual a API pertence. Obtenha o ID do grupo seguindo as instruções em Consulta da lista de grupos da API.
   • name: nome da API
   • req_method: método de solicitação da API
   • req_uri: endereço de acesso da API
   • type: tipo da API. 1 significa API pública e 2 significa API privada.
   • result_normal_sample: exemplo de resposta para uma solicitação bem-sucedida
   Depois de registrar a API, visualize-a no console do APIG.

   Figura 1 Visualizar a API