Consulta da lista de canais da VPC
Função
Esta API é usada para consultar a lista de canais da VPC que foram criados.
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/vpc-channels[?page_size, page_no, id, name, vpc_type] |
o
- 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: id, name, vpc_type, page_size e page_no.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Não |
String |
ID do canal da VPC |
name |
Não |
String |
Nome do canal da VPC |
vpc_type |
Não |
Integer |
Tipo de canal da VPC, que pode ser: |
page_size |
Não |
Integer |
Número de canais da VPC 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 total de canais da VPC que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de canais da VPC retornada |
vpcs |
Dicionário |
Lista de canais da VPC |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do canal da VPC |
name |
String |
Nome do canal da VPC |
type |
Integer |
Tipo de canal da VPC, que pode ser:
|
member_type |
String |
Tipo de membro do canal da VPC, que pode ser:
|
status |
Integer |
O status do canal da VPC, que pode ser:
|
port |
Integer |
Porta do host do canal da VPC |
balance_strategy |
Integer |
Algoritmo de distribuição, que pode ser:
|
create_time |
Timestamp |
Hora em que o canal da VPC é criado |
Exemplo de resposta:
{ "total": 2, "size": 2, "vpcs": [ { "name": "Channel_1", "type": 1, "member_type": "instance", "port": 8080, "balance_strategy": 1, "id": "39c62689302a48fe9f4bd7cf5c052064", "create_time": "2018-04-24T12:07:58Z", "status": 1 }, { "name": "Channel_2", "type": 2, "member_type": "instance", "port": 8088, "balance_strategy": 1, "id": "e6831cbcbe2b45bbbc6318c2892f060b", "create_time": "2018-04-24T11:57:03Z", "status": 1 } ] }
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 |