Consulta de uma lista de APIs
Função
Esta API é usada para consultar uma lista de APIs para retornar detalhes e informações de publicação das APIs. As informações de back-end das APIs não serão retornadas.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
GET |
/v1.0/apigw/apis[?page_size, page_no, id, name, group_id, req_protocol, req_method, req_uri, auth_type, env_id, type,status, tags] |
- Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
- As condições de consulta incluem: ID, name, group_id, req_protocol, req_method, req_uri, auth_type, env_id, type, status, tags, page_size e page_no.
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Não |
String |
ID da API |
name |
Não |
String |
Nome da API |
group_id |
Não |
String |
ID do grupo de APIs ao qual a API pertence |
req_protocol |
Não |
String |
Protocolo de solicitação |
req_method |
Não |
String |
Método de solicitação |
req_uri |
Não |
String |
Caminho de solicitação |
auth_type |
Não |
String |
Modo de autenticação de segurança |
env_id |
Não |
String |
ID do ambiente no qual a API foi publicada |
type |
Não |
Integer |
Tipo de API |
page_size |
Não |
Integer |
Número de registros exibidos em cada página. O valor padrão é 20 e o valor máximo é 500. Quando o valor de page_size está definido como 0, todas as APIs são retornadas. |
page_no |
Não |
Integer |
Número da página. O valor padrão é 1. |
precise_search |
Não |
String |
Nome do parâmetro (name ou req_uri) para correspondência exata |
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Número de APIs que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de API retornada |
apis |
Dicionário |
Lista de APIs |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da API |
name |
String |
Nome da API |
group_id |
String |
ID do grupo de APIs ao qual a API pertence |
group_name |
String |
Nome do grupo de APIs ao qual a API pertence |
status |
Integer |
Status da API |
type |
Integer |
Tipo de API |
version |
String |
Versão da API |
req_protocol |
String |
Protocolo de solicitação |
req_method |
String |
Método de solicitação |
req_uri |
String |
Endereço de acesso |
auth_type |
String |
Modo de autenticação de segurança |
auth_opt |
Object |
Parâmetro de modo de autenticação de segurança |
authorizer_id |
String |
ID do autorizador personalizado do front-end |
match_mode |
String |
Modo de correspondência |
register_time |
Timestamp |
Hora em que a API é registrada |
update_time |
Timestamp |
Hora em que a API foi modificada pela última vez |
remark |
String |
Descrição da API |
bakend_type |
String |
Tipo de back-end |
run_env_name |
String |
Nome do ambiente no qual a API foi publicada |
run_env_id |
String |
ID do ambiente no qual a API foi publicada |
publish_id |
String |
ID do registro de publicação |
arrange_necessary |
Integer |
Indica se a orquestração é necessária. |
cors |
Bool |
Indica se o CORS é suportado. |
tag |
String |
Tag de nome de serviço, que deve ser descartada |
tags |
[]String |
Tags da API |
response_id |
String |
ID da resposta do gateway |
Parâmetro |
Tipo |
Descrição |
---|---|---|
app_code_auth_type |
String |
Indica se a autenticação de AppCode está habilitada. |
Exemplo de resposta:
{ "total": 3, "size": 3, "apis": [ { "name": "test", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test/{project_id}", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "DISABLE" }, "tags": ["APIG-SN-test", "test"], "cors": false, "match_mode": "NORMAL", "backend_type": "HTTP", "group_id": "f71f69876f90456ca6fd18ed012fdc11", "id": "81efcfd94b8747a0b21e8c04144a4e8c", "status": 1, "arrange_necessary": 2, "register_time": "2018-08-15T03:41:11Z", "update_time": "2018-08-15T03:41:11Z", "group_name": "group0002" }, { "name": "bbbbb", "type": 1, "version": "0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test002", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "DISABLE" }, "tags": ["APIG-SN-test", "test"], "cors": false, "match_mode": "NORMAL", "backend_type": "MOCK", "remark": "aaa", "group_id": "70f1b578da9b4dfe889b4c33d1b995c2", "id": "91c26288acea4448be205265d77dae22", "status": 1, "arrange_necessary": 2, "register_time": "2018-07-27T11:54:24Z", "update_time": "2018-07-27T11:54:24Z", "group_name": "test001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "a6e06a00c382436eb524fa2dd343cb6d" }, { "name": "aaa", "type": 1, "version": "0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test001", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "DISABLE" }, "tags": ["APIG-SN-test", "test"], "cors": false, "match_mode": "NORMAL", "backend_type": "MOCK", "remark": "aaa", "group_id": "70f1b578da9b4dfe889b4c33d1b995c2", "id": "aebacac6095942b4b2dd2b209bb7b9bc", "status": 1, "arrange_necessary": 2, "register_time": "2018-07-27T11:23:34Z", "update_time": "2018-07-27T11:23:34Z", "group_name": "test001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "1bc8b2b741a04bd4af3ef9d7cd003104" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Solicitação inválida |
401 |
Não autorizado |
500 |
Erro do servidor interno |