Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ VPC Endpoint/ Referencia de la API/ API/ Puntos de conexión de VPC/ Consulta de punto de conexión de VPC

Actualización más reciente 2024-09-14 GMT+08:00

Ver PDF

Consulta de punto de conexión de VPC

Función

Esta API se utiliza para consultar puntos de conexión de VPC.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

GET /v1/{project_id}/vpc-endpoints

**Tabla 1** Parámetros de enrutamiento
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto. Mínimo: 1 Máximo: 64

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
endpoint_service_name	No	String	Especifica el nombre del servicio de punto de conexión de VPC. El nombre no distingue entre mayúsculas y minúsculas y admite coincidencias difusas. Mínimo: 1 Máximo: 128
vpc_id	No	String	Especifica el ID de la VPC donde se creará el punto de conexión de VPC. Mínimo: 1 Máximo: 64
id	No	String	Especifica el ID único del punto de conexión de VPC. Mínimo: 1 Máximo: 64
limit	No	Integer	Especifica el número máximo de puntos de conexión de VPC que se muestran en cada página. El valor oscila entre 0 y 500 y generalmente es de 10, 20 o 50. El número predeterminado es 10. Mínimo: 1 Máximo: 1000 Predeterminado: 10
offset	No	Integer	Especifica el desfase. Se consultarán todos los servicios de punto de conexión de VPC después de este desfase. El desfase debe ser un entero mayor que 0 pero menor que la cantidad de servicios punto de conexión de VPC. Mínimo: 0
sort_key	No	String	Especifica el campo de clasificación de los puntos de conexión de VPC, que puede ser: ●create_at: los puntos de conexión de VPC se ordenan por tiempo de creación. ●update_at: los puntos de conexión de VPC se ordenan por hora de actualización. El campo predeterminado es create_at. Valor predeterminado: create_at
sort_dir	No	String	Especifica el método de clasificación de los puntos de conexión de VPC, que puede ser: ● desc: se ordenan los puntos de conexión de VPC en orden descendente. ● asc: los puntos de conexión de VPC se ordenan en orden ascendente. El método predeterminado es desc. Predeterminado: desc
public_border_group	No	String	Especifica el servicio de punto de conexión de VPC que coincide con el atributo de borde en el resultado del filtrado.

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token de usuario. Se puede obtener invocando a la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.
Content-Type	No	String	Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía en función del tipo de flujo. Valor predeterminado: application/json

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
endpoints	Array of EndpointResponseBody objects	Especifica los puntos de conexión de VPC.
total_count	Integer	Especifica el número total de puntos de conexión de VPC que cumplen los criterios de búsqueda. El número no se ve afectado por limit ni offset.

**Tabla 5** EndpointResponseBody
Parámetro	Tipo	Descripción
id	String	Especifica el ID único del punto de conexión de VPC. Mínimo: 1 Máximo: 64
service_type	String	Especifica el tipo de servicio de punto de conexión de VPC al que se conecta el punto de conexión de VPC. gateway: Indica los servicios de punto de conexión de VPC configurados por el personal de O&M. Puede usarlos directamente sin crearlos usted mismo. interface: indica los servicios en la nube configurados por el personal de O&M y los servicios privados creados por ustedes. No puede configurar estos servicios en la nube, pero puede utilizarlos. Puede consultar los servicios de punto de conexión públicos de VPC para ver los servicios de punto de conexión de VPC visibles y accesibles para todos los usuarios y configurados por el personal de O&M. Se pueden crear servicios de punto de conexión de VPC de interfaz.
status	String	Especifica el estado del punto de conexión de VPC. pendingAcceptance: Se aceptará el punto de conexión de VPC. creating: Se está creando el punto de conexión de VPC. accepted: Se ha aceptado el punto de conexión de VPC. rejected: Se ha rechazado el punto de conexión de VPC. failed: No se pudo crear el punto de conexión de VPC. deleting: Se está eliminando el punto de conexión de VPC.
active_status	Array of strings	Especifica el estado de la cuenta. frozen: La cuenta está congelada. active: La cuenta está normal.
endpoint_service_name	String	Especifica el nombre del servicio de punto de conexión de VPC.
marker_id	Integer	Especifica el ID de paquete del punto de conexión de VPC.
endpoint_service_id	String	Especifica el ID del servicio de punto de conexión de VPC. Mínimo: 1 Máximo: 64
enable_dns	Boolean	Especifica si se debe crear un nombre de dominio. true: cree un nombre de dominio. false: no cree un nombre de dominio. Nota Al crear un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de gateway, no se crea ningún nombre de dominio, independientemente de si enable_dns está configurado como true o false.
dns_names	Array of strings	Especifica el nombre de dominio para acceder al servicio de punto de conexión de VPC asociado. Este parámetro está disponible cuando enable_dns se establece en true. Mínimo: 0 Máximo: 32
ip	String	Especifica la dirección IP para acceder al servicio de punto de conexión de VPC asociado. Este parámetro solo se devuelve en las siguientes condiciones: Se consulta un punto de conexión de VPC para acceder a un servicio de punto de conexión de VPC de interfaz. La aprobación de conexión está habilitada para el servicio de punto de conexión de VPC y la conexión ha sido aprobada. status del punto de conexión de VPC puede ser accepted o rejected. El estado rejected solo aparece cuando se acepta y luego se rechaza el punto de conexión de VPC. Mínimo: 1 Máximo: 64
vpc_id	String	Especifica el ID de la VPC donde se creará el punto de conexión de VPC. Mínimo: 1 Máximo: 64
subnet_id	String	Especifica el ID de la subred en la VPC especificada por vpc_id. El ID está en formato de UUID. Mínimo: 1 Máximo: 64
created_at	String	Especifica cuándo se creó el punto de conexión de VPC. Se utiliza el formato de hora de UTC AAAA-MM-DDTHH:MM:SSZ.
updated_at	String	Especifica el tiempo de actualización del punto de conexión de VPC. Se utiliza el formato de hora de UTC AAAA-MM-DDTHH:MM:SSZ.
project_id	String	Especifica el ID del proyecto. Para obtener detalles sobre cómo obtener el ID de proyecto, consulte "Obtención de un ID de proyecto". Mínimo: 1 Máximo: 64
tags	Array of TagList objects	Especifica la lista de etiquetas consultadas. Si no hay ninguna etiqueta coincidente, se devuelve una matriz vacía.
error	Array of QueryError objects	Especifica el mensaje de error. Este campo se devuelve cuando el punto de conexión de VPC es anormal, es decir, el valor de status es failed.
whitelist	Array of strings	Especifica la lista blanca para controlar el acceso al punto de conexión de VPC. Si no especifica este parámetro, se devolverá una lista blanca vacía. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de interfaz. Mínimo: 0 Máximo: 32 Longitud del arreglo: 1 - 1000
enable_whitelist	Boolean	Especifica si el control de acceso está habilitado. true: El control de acceso está habilitado. false: El control de acceso está desactivado. Si no especifica este parámetro, se desactiva el control de acceso. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de interfaz.
routetables	Array of strings	Especifica los ID de las tablas de enrutamientos. Si no se especifica este parámetro, se devuelve el ID de la tabla de enrutamiento de la VPC predeterminada. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de gateway. Mínimo: 0 Máximo: 64
description	String	Especifica el campo de descripción. El valor puede contener caracteres como letras y dígitos, pero no puede contener signos menores que (<) ni mayores que signos (>). Mínimo: 0 Máximo: 512
policy_statement	Array of PolicyStatement objects	Este campo aparece en el cuerpo de la respuesta solo para los puntos de conexión de VPC que tengan configuradas políticas de punto de conexión de VPC y de bucket de OBS. Longitud del arreglo: 0 - 10
endpoint_pool_id	String	(Se descartará) Especifica el ID del clúster asociado al punto de conexión de VPC. Mínimo: 1 Máximo: 64
public_border_group	String	Especifica la información sobre el grupo de borde público asociado con el punto de conexión de VPC. Este parámetro se devuelve solo cuando el punto de conexión de VPC está asociado con un grupo de bordes.

**Tabla 6** TagList
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Una clave de etiqueta contiene un máximo de 36 caracteres de Unicode. No puede quedar en blanco. No puede contener signos iguales (=), asteriscos (*), menos que signos (<), mayor que signos (>), barras invertidas (), comas (,), barras verticales (\|), y barras (/), y los caracteres primero y último no pueden ser espacios. Mínimo: 1 Máximo: 36
value	String	Especifica la clave de etiqueta. Un valor de etiqueta contiene un máximo de 43 caracteres y puede ser una cadena vacía. No puede contener signos iguales (=), asteriscos (*), menos que signos (<), mayor que signos (>), barras invertidas (), comas (,), barras verticales (\|), y barras (/), y los caracteres primero y último no pueden ser espacios. Mínimo: 1 Máximo: 43

**Tabla 7** QueryError
Parámetro	Tipo	Descripción
error_code	String	Código de error. Mínimo: 0 Máximo: 10
error_message	String	Mensaje de error. Mínimo: 0 Máximo: 1024

**Tabla 8** PolicyStatement
Parámetro	Tipo	Descripción
Effect	String	Especifica si se debe aceptar o rechazar el objeto o los permisos de OBS.
Action	Array of strings	Especifica los permisos del acceso de OBS.
Resource	Array of strings	Especifica el objeto de OBS.

Ejemplo de las solicitudes

Consulta de punto de conexión de VPC

GET https://{endpoint}/v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}

Ejemplo de las respuestas

Código de estado: 200

El servidor procesó correctamente la solicitud.

{
  "endpoints" : [ {
    "id" : "03184a04-95d5-4555-86c4-e767a371ff99",
    "status" : "accepted",
    "ip" : "192.168.0.232",
    "marker_id" : 16777337,
    "active_status" : "active",
    "vpc_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
    "service_type" : "interface",
    "project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
    "subnet_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
    "enable_dns" : "true",
    "dns_names" : [ "test123" ],
    "created_at" : "2018-10-18T06:49:46Z",
    "updated_at" : "2018-10-18T06:49:50Z",
    "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
    "endpoint_service_name" : "test123",
    "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
    "public_border_group" : "br-abc-aaa1",
    "whitelist" : [ "127.0.0.1" ],
    "enable_whitelist" : true
  }, {
    "id" : "43b0e3b0-eec9-49da-866b-6687b75f9fe5",
    "status" : "accepted",
    "ip" : "192.168.0.115",
    "marker_id" : 16777322,
    "active_status" : "active",
    "vpc_id" : "e251b400-2963-4131-b38a-da81e32026ee",
    "service_type" : "interface",
    "project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
    "subnet_id" : "65528a22-59a1-4972-ba64-88984b3207cd",
    "enable_dns" : "true",
    "dns_names" : [ "test123" ],
    "created_at" : "2018-10-18T06:36:20Z",
    "updated_at" : "2018-10-18T06:36:24Z",
    "endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
    "endpoint_service_name" : "test123",
    "endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
    "whitelist" : [ "127.0.0.1" ],
    "enable_whitelist" : true
  } ],
  "total_count" : 2
}

Ejemplo de código del SDK

El ejemplo de código del SDK es el siguiente.

Java

    
     
       
       
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion;
import com.huaweicloud.sdk.vpcep.v1.*;
import com.huaweicloud.sdk.vpcep.v1.model.*;


public class ListEndpointsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        VpcepClient client = VpcepClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcepRegion.valueOf("cn-north-4"))
                .build();
        ListEndpointsRequest request = new ListEndpointsRequest();
        request.withEndpointServiceName("<endpoint_service_name>");
        request.withVpcId("<vpc_id>");
        request.withId("<id>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        request.withPublicBorderGroup("<public_border_group>");
        try {
            ListEndpointsResponse response = client.listEndpoints(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      

    
   

Python

    
     
       
       
         # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpcep.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListEndpointsRequest()
        request.endpoint_service_name = "<endpoint_service_name>"
        request.vpc_id = "<vpc_id>"
        request.id = "<id>"
        request.limit = <limit>
        request.offset = <offset>
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        request.public_border_group = "<public_border_group>"
        response = client.list_endpoints(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      

    
   

Go

    
     
       
       
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := vpcep.NewVpcepClient(
        vpcep.VpcepClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListEndpointsRequest{}
	endpointServiceNameRequest:= "<endpoint_service_name>"
	request.EndpointServiceName = &endpointServiceNameRequest
	vpcIdRequest:= "<vpc_id>"
	request.VpcId = &vpcIdRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	publicBorderGroupRequest:= "<public_border_group>"
	request.PublicBorderGroup = &publicBorderGroupRequest
	response, err := client.ListEndpoints(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      

    
   

Otro más

Para obtener un ejemplo de código del SDK de más lenguajes de programación, consulta la ficha Ejemplo de código en API Explorer. El ejemplo de código del SDK se puede generar automáticamente.