Consulta de gateways virtuais
Função
Essa API é usada para consultar gateways virtuais.
URI
GET /v3/{project_id}/dcaas/virtual-gateways
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | Especifica o ID do projeto. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
limit | Não | Integer | Especifica o número de registros retornados em cada página. Intervalo de valores: 1 a 2000 Mínimo: 1 Máximo: 2000 Padrão: 2000 |
marker | Não | String | Especifica o ID do último registro de recurso na página anterior. Se este parâmetro for deixado em branco, a primeira página será consultada. Este parâmetro deve ser usado junto com limit. Mínimo: 0 Máximo: 36 |
fields | Não | Array | Especifica a lista de campos a serem exibidos. |
sort_dir | Não | Array | Especifica a ordem de classificação dos resultados retornados, que pode ser asc (ordem crescente) ou desc (ordem decrescente). O valor padrão é asc. |
sort_key | Não | String | Especifica o campo de classificação. Padrão: created_at Mínimo: 0 Máximo: 36 |
id | Não | Array | Especifica o ID do recurso pelo qual as instâncias são filtradas. |
vpc_id | Não | Array | Especifica o ID da VPC pelo qual os gateways virtuais são filtrados. |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Especifica o token do usuário. Para obter o token, consulte a seção "Obtenção do token do usuário" na Referência de API do Identity and Access Management. O token é o valor de X-Subject-Token no cabeçalho de resposta. Mínimo: 0 Máximo: 10240 |
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
request_id | String | Especifica o ID da solicitação. |
virtual_gateways | Array of VirtualGateway objects | Especifica parâmetros para a criação de um gateway virtual. |
page_info | PageInfo object | Especifica as informações de consulta de paginação. |
Parâmetro | Tipo | Descrição |
|---|---|---|
id | String | Especifica o ID do gateway virtual. |
vpc_id | String | Especifica o ID da VPC conectada pelo gateway virtual. |
tenant_id | String | Especifica o ID do projeto ao qual a instância pertence. Mínimo: 32 Máximo: 32 |
name | String | Especifica o nome do gateway virtual. Mínimo: 0 Máximo: 64 |
description | String | Fornece informações suplementares sobre o gateway virtual. Mínimo: 0 Máximo: 128 |
type | String | Especifica o tipo de gateway virtual. O valor só pode ser default. Padrão: default Valores de enumeração:
|
local_ep_group | Array of strings | Especifica as sub-redes IPv4 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. |
local_ep_group_ipv6 | Array of strings | Especifica as sub-redes IPv6 conectadas pelo gateway virtual, que geralmente são os blocos CIDR de uma VPC. Este é um campo reservado. |
admin_state_up | Boolean | Especifica o status administrativo, que pode ser true ou false. Padrão: true |
status | String | Especifica o status do gateway virtual, que pode ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE ou PENDING_DELETE. |
bgp_asn | Integer | Especifica o ASN BGP local do gateway virtual. Mínimo: 1 Máximo: 4294967295 |
enterprise_project_id | String | Especifica o ID do projeto empresarial ao qual o gateway virtual pertence. Mínimo: 36 Máximo: 36 |
tags | Array of Tag objects | Especifica as tags. |
Parâmetro | Tipo | Descrição |
|---|---|---|
key | String | Especifica a chave de tag. A chave pode conter no máximo 36 caracteres Unicode, incluindo letras, dígitos, hifens (-) e sublinhados (_). Mínimo: 0 Máximo: 36 |
value | String | Especifica o valor de tag. O valor pode conter no máximo 43 caracteres Unicode, incluindo letras, dígitos, hifens (-) sublinhados (_) e pontos (.). Mínimo: 0 Máximo: 43 |
Parâmetro | Tipo | Descrição |
|---|---|---|
previous_marker | String | Especifica o marcador da página anterior. O valor é o UUID do recurso. Mínimo: 0 Máximo: 36 |
current_count | Integer | Especifica o número de recursos na lista atual. Mínimo: 0 Máximo: 2000 |
next_marker | String | Especifica o marcador da próxima página. O valor é o UUID do recurso. Se o valor estiver vazio, o recurso está na última página. Mínimo: 0 Máximo: 36 |
Exemplos de solicitações
Consulta da lista de gateways virtuais
GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways Exemplo de respostas
Código de status: 200
OK
{
"virtual_gateways" : [ {
"id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
"name" : "vgw-c7b22",
"description" : "",
"tenant_id" : "0605768a3300d5762f82c01180692873",
"vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.1.0/24" ],
"enterprise_project_id" : "0"
} ],
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
} Códigos de status
Código de status | Descrição |
|---|---|
200 | OK |
Códigos de erro
Consulte Códigos de erro.

