Consulta de chamadas de API dentro de um período
Função
Esta API é usada para consultar o número de vezes que as APIs de um grupo de APIs são chamadas dentro de um período. A consulta é baseada em 1 minuto. Se o intervalo de tempo estiver dentro de uma hora, o servidor retornará o número de chamadas de API feitas a cada minuto.
Para fins de segurança, limpe seus registros de operação, incluindo, entre outros, registros nos diretórios ~/.bash_history e /var/log/messages (se houver), após executar o comando curl no servidor para consultar informações.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/api/latest
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento. |
instance_id | Sim | String | ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
api_id | Sim | String | ID da API. |
duration | Sim | String | Intervalo de tempo (unidade: h ou m). Por exemplo, 1h refere-se à última 1 hora e 1m refere-se ao último 1 minuto. |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. |
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
code | String | Código de resposta. |
msg | String | Mensagem de resposta. |
start_time | Long | Carimbo de data/hora (UTC) da hora de início. |
end_time | Long | Carimbo de data/hora (UTC) da hora final. |
list | Array of StatisticsAPI objects | Dados estatísticos. |
Parâmetro | Tipo | Descrição |
|---|---|---|
max_latency | Integer | Máxima latência. Unidade: ms |
avg_latency | Float | Latência média. Unidade: ms |
req_count | Integer | Número total de solicitações. |
req_count2xx | Integer | Número total de códigos de resposta 2xx. |
req_count4xx | Integer | Número total de códigos de resposta 4xx. |
req_count5xx | Integer | Número total de códigos de resposta 5xx. |
req_count_error | Integer | Erros. |
max_inner_latency | Integer | Máxima latência de gateway. Unidade: ms |
avg_inner_latency | Float | Latência média do gateway. Unidade: ms |
max_backend_latency | Integer | Máxima latência de back-end. |
avg_backend_latency | Float | Latência média de back-end. |
output_throughput | Long | Taxa de transferência de downstream (bytes). |
input_throughput | Long | Taxa de transferência de upstream (bytes). |
current_minute | Long | Carimbo de data/hora (UTC) do acesso à API |
cycle | String | Período estatístico. Valores de enumeração:
|
api_id | String | ID da API. |
group_id | String | ID do grupo da API. |
provider | String | Fornecedor de API. |
req_time | String | Tempo de solicitação. |
register_time | String | Tempo de gravação. |
status | Integer | Status. |
Código de status: 400
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 401
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 403
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 404
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 500
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
OK
{
"code" : "APIG.0000",
"start_time" : 1595573280,
"end_time" : 1595576820,
"list" : [ {
"api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9",
"avg_backend_latency" : 2.71,
"avg_inner_latency" : 1.57,
"avg_latency" : 4.14,
"current_minute" : 1595576640,
"cycle" : "MINUTE",
"group_id" : "d0fc4e40b7d1492cba802f667c7c7226",
"input_throughput" : 1071,
"max_backend_latency" : 6,
"max_inner_latency" : 8,
"max_latency" : 14,
"output_throughput" : 3790,
"provider" : "73d69ae0cfcf460190522d06b60f05ad",
"register_time" : "2020-07-24 15:44:56",
"req_count" : 7,
"req_count2xx" : 0,
"req_count4xx" : 6,
"req_count5xx" : 1,
"req_count_error" : 7,
"req_time" : "2020-07-24 15:44:00",
"status" : 1
} ]
} Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation"
} Código de status: 401
Não autorizado
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de status: 403
Proibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de status: 404
Não encontrado
{
"error_code" : "APIG.3002",
"error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist"
} Código de status: 500
Erro do servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} 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 |
500 | Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.
