Consulta de uma lista de ambientes
Função
Esta API é usada para consultar uma lista de ambientes que corresponda às condições especificadas.
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/envs[?page_no, page_size,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: name, page_size e page_no.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Não |
String |
Nome do ambiente |
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. |
precise_search |
Não |
String |
Nome do parâmetro (name) para correspondência exata |
Solicitação
N/D
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Número de ambientes que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de ambiente retornada |
envs |
Dicionário |
Lista de ambiente |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do ambiente |
name |
String |
Nome do ambiente |
create_time |
Timestamp |
Momento em que o ambiente é criado |
remark |
String |
Descrição do ambiente |
Exemplo de resposta:
{ "total": 2, "size": 2, "envs": [{ "id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "name": "RELEASE", "remark": "Production environment", "create_time": "2017-12-29T03:39:03.165657Z" }, { "id": "cca3616a-f368-4b32-9064-b2a631cb3eeb", "name": "DEVELOP", "remark": "Development environment", "create_time": "2017-12-28T12:50:47Z" }] }
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 |