Consulta da definição de tempo de execução de uma API
Função
Esta API é usada para consultar a definição de tempo de execução de uma API em um ambiente especificado. A definição de tempo de execução de uma API no ambiente RELEASE é consultada se nenhum ambiente for especificado.
A definição de uma API é classificada nos seguintes tipos:
- Definição temporária: definição de uma API usada após a última edição da API.
- Definição de tempo de execução: instantâneo da definição temporária de uma API capturada quando a API é publicada em um ambiente.
A definição de tempo de execução de uma API é acessada quando a API é chamada em um ambiente.
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/runtime/{id}[?env_id] |
- Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
- A condição de consulta é env_id.
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID da API |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
env_id |
Não |
String |
ID do ambiente em que a API é publicada |
Resposta
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 |
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 |
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 |
tag |
String |
Tag de nome de serviço, que deve ser descartada |
tags |
[]String |
Tags da API |
cors |
Bool |
Indica se o CORS é suportado. |
body_remark |
String |
Descrição do corpo da solicitação da API, que pode ser um exemplo de corpo da solicitação, tipo de mídia ou informações de parâmetro |
result_normal_sample |
String |
Exemplo de resposta para uma solicitação bem-sucedida |
result_failure_sample |
String |
Exemplo de resposta para uma solicitação com falha |
response_id |
String |
ID da resposta do gateway |
sl_domain |
String |
Nome do subdomínio do grupo de APIs |
sl_domains |
Array of strings |
Lista de nomes de subdomínio vinculados ao grupo de APIs |
req_params |
Dicionário |
Lista de parâmetros de solicitação |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do parâmetro |
name |
String |
Nome do parâmetro |
type |
String |
Tipo de parâmetro |
location |
String |
Localização do parâmetro |
default_value |
String |
Valor padrão |
sample_value |
String |
Exemplo de valor |
required |
Integer |
Indica se o parâmetro é obrigatório. |
valid_enable |
Integer |
Indica se a verificação de validade está habilitada. |
remark |
String |
Descrição do parâmetro |
enumerations |
String |
Valor enumerado |
min_num |
Integer |
Valor mínimo, que é válido quando o tipo de parâmetro é NUMBER |
max_num |
Integer |
Valor máximo, que é válido quando o tipo de parâmetro é NUMBER |
min_size |
Integer |
Comprimento mínimo |
max_size |
Integer |
Comprimento máximo |
regular |
String |
Regra de validação de expressão regular |
json_schema |
String |
Regra de validação JSON |
Parâmetro |
Tipo |
Descrição |
---|---|---|
app_code_auth_type |
String |
Indica se a autenticação de AppCode está habilitada. |
Exemplo de resposta:
{ "name": "market_api01", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test01", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "HEADER" }, "tags": ["APIG-SN-test", "test"], "cors": true, "match_mode": "NORMAL", "backend_type": "MOCK", "remark": "market_api01", "group_id": "7f848adc971749cda9c6aff3877cfc3e", "body_remark": "market_api01", "result_normal_sample": "success", "result_failure_sample": "", "id": "0e51b689e0784bc884f43756bbf34fa5", "group_name": "market_group01", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "run_env_name": "RELEASE", "publish_id": "f07eb9f5e5ba4bbfbe89326f5cae99c7", "sl_domain": "61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "sl_domains": ["61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "61297835ff1e4905b6f635dbcdf1777e.apigw.example.cn"], "req_params": [ { "name": "project_id", "type": "STRING", "location": "PATH", "default_value": "", "sample_value": "", "required": 1, "valid_enable": 2, "remark": "", "enumerations": "", "min_num": 0, "max_num": 0, "min_size": 0, "max_size": 0, "regular": "", "json_schema": "", "id": "2a61905ea2304186a9422faba2940735" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
400 |
Solicitação inválida |
401 |
Não autorizado |
403 |
Proibido |
404 |
Não encontrado |