Consulta de detalhes da configuração
Função
Esta API é usada para consultar as configurações e os valores de configuração de um locatário.
URI
|
Método de solicitação |
URI |
|---|---|
|
GET |
/v1.0/apigw/config/project[?page_size, page_no, config_id, config_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: config_name, config_id, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
config_name |
Não |
String |
Nome da configuração |
|
config_id |
Não |
String |
ID de configuração |
|
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 configurações que correspondem às condições de consulta |
|
size |
Integer |
Comprimento da lista de configuração retornada |
|
configs |
Dicionário |
Lista de configuração |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
config_id |
String |
ID de configuração |
|
config_name |
String |
Nome da configuração |
|
config_value |
String |
Valor de configuração |
|
remark |
String |
Descrição da configuração |
|
config_time |
Timestamp |
Hora em que a configuração é criada |
Exemplo de resposta:
{
"total": 3,
"size": 3,
"configs": [
{
"config_id": "1",
"config_name": "API_NUM_LIMIT",
"config_value": "300",
"config_time": "2017-12-29T08: 00: 39.543642Z",
"remark": "Maximum number of APIs a tenant can create"
},
{
"config_id": "2",
"config_name": "APP_NUM_LIMIT",
"config_value": "30",
"config_time": "2017-12-29T03: 39: 03.165657Z",
"remark": "Maximum number of apps a tenant can create"
},
{
"config_id": "3",
"config_name": "APIGROUP_NUM_LIMIT",
"config_value": "30",
"config_time": "2017-12-29T03: 39: 03.165657Z",
"remark": "Maximum number of API groups a tenant can create"
}
]
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
OK |
|
401 |
Não autorizado |
|
403 |
Proibido |
|
500 |
Erro do servidor interno |