Consulta da lista de APIs compradas
Função
Esta API é usada para consultar a lista de APIs compradas.
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/purchases/apis[?page_size, page_no, api_id, api_name, group_id, group_name] |
- 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: api_id, api_name, group_id, group_name, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
api_id |
Não |
String |
ID da API |
|
api_name |
Não |
String |
Nome da API |
|
group_id |
Não |
String |
ID do grupo da API |
|
group_name |
Não |
String |
Nome do grupo da API |
|
page_size |
Não |
Integer |
Número de registros exibidos em cada página. O valor padrão é 20. |
|
page_no |
Não |
Integer |
Número da página. O valor padrão é 1. |
Solicitação
N/D
Resposta
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
total |
Integer |
Número total de APIs que correspondem às condições de consulta |
|
size |
Integer |
Número de APIs retornadas |
|
apis |
Dicionário |
Lista de APIs |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID da API |
|
name |
String |
Nome da API |
|
purchase_id |
String |
ID da subscrição |
|
remark |
String |
Descrição da API |
|
req_uri |
String |
Endereço de acesso |
Exemplo de resposta:
{
"total": 3,
"size": 3,
"apis": [{
"id": "cb498965-8acf-4c98-bd08-4033ef1fcfb4",
"name": "Environment_list_query",
"purchase_id": "730f8a84-c8db-45ba-a6a5-2669ceb08574",
"remark": "Environment list query",
"req_uri": "/envs"
},
{
"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
"name": "API_group_list_query",
"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
"remark": "API group list query",
"req_uri": "/groups"
},
{
"id": "6632a062-9dcf-4f18-9646-3cabb925a290",
"name": "API_list_query",
"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
"remark": "API list query",
"req_uri": "/apis"
}]
}
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 |