Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Virtual Private Network/ Referência de API/ APIs da VPN da edição profissional/ Gateway de cliente/ Consulta da lista de gateways de cliente

Atualizado em 2023-08-04 GMT+08:00

Ver PDF

Consulta da lista de gateways de cliente

Função

Esta API é usada para consultar a lista de gateways de cliente.

URI

GET /v5/{project_id}/customer-gateways

**Tabela 1** Descrição do parâmetro
Parâmetro	Tipo	Obrigatório	Descrição
project_id	String	Sim	Especifica o ID do projeto. Você pode obter o ID do projeto, referindo-se a Obtenção do ID do projeto.

**Tabela 2** Parâmetro em uma solicitação de consulta
Parâmetro	Tipo	Obrigatório	Descrição
limit	Integer	Não	Especifica o número de registros retornados em cada página durante a consulta de paginação. O valor varia de 0 a 200. O valor padrão é 200.
marker	String	Não	Especifica o sinalizador de início para consultar a página atual. Se este parâmetro for deixado em branco, a primeira página será consultada. O marker para consultar a próxima página é o next_marker no objeto page_info retornado na página atual. Este parâmetro deve ser usado com limit.

Solicitação

Parâmetros de solicitação
Nenhum

Exemplo de solicitação

GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&marker={marker}

Resposta

Parâmetros de resposta

Código de status 200 retornado: consulta bem-sucedida

**Tabela 3** Parâmetros no corpo da resposta
Parâmetro	Tipo	Descrição
customer_gateways	Array of ResponseCustomerGateway	Especifica o objeto de gateway de cliente.
total_count	Long	Especifica o número total de gateways de cliente de um locatário.
page_info	PageInfo	Especifica as informações da paginação.
request_id	String	Especifica um ID da solicitação.

**Tabela 4** ResponseCustomerGateway
Parâmetro	Tipo	Descrição
id	String	Especifica um ID de gateway de cliente. O valor é um UUID contendo 36 caracteres.
name	String	Especifica um nome de gateway de cliente. Se nenhum nome de gateway de cliente for especificado, o sistema gera um automaticamente. O valor é uma cadeia de 1 a 64 caracteres, que pode conter dígitos, letras, sublinhados (_) e hifens (-).
route_mode	String	Especifica o modo de roteamento do gateway de cliente. O valor pode ser static ou bgp.
bgp_asn	Long	Especifica o número do sistema autônomo do BGP do gateway do cliente. Este parâmetro só está disponível quando route_mode está definido como bgp.
ip	String	Especifica o endereço IP do gateway do cliente. O valor é um endereço IPv4, por exemplo, 10.*.*.21.
created_at	String	Especifica a hora em que o gateway de cliente é criado.
updated_at	String	Especifica a hora da última atualização.

**Tabela 5** PageInfo
Parâmetro	Tipo	Descrição
next_marker	String	Especifica o marcador da próxima página. O valor é o momento em que o último recurso na última resposta de consulta foi criado.
current_count	Integer	Especifica o número de recursos na lista. Se o valor de current_count for menor que o valor de limit na solicitação de consulta, a página atual será a última página.

Exemplo de resposta

{
    "customer_gateways": [{
        "id": "e67d6e27-****-****-****-be9a0f0168e9",
        "name": "cgw-a45b",
        "route_mode": "bgp",
        "bgp_asn": 65588,
        "ip": "100.***.***.81",
        "created_at": "2022-11-28T07:36:24.923Z",
        "updated_at": "2022-11-28T07:36:24.923Z"
    }, {
        "id": "312067bb-****-****-****-09dc941bbffc",
        "name": "cgw-21a3",
        "route_mode": "static",
        "ip": "100.***.***.55",
        "created_at": "2022-11-28T06:25:01.937Z",
        "updated_at": "2022-11-28T06:25:01.937Z"
    }],
    "total_count": 2,
    "page_info": {
        "next_marker": "2022-11-28T06:25:01.937Z",
        "current_count": 2
    },
    "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
}