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 servicios públicos de punto de conexión de VPC
Actualización más reciente 2023-01-06 GMT+08:00

Consulta de servicios públicos de punto de conexión de VPC

Función

Esta API se utiliza para consultar servicios públicos de punto de conexión de VPC. Estos servicios son creados por ingenieros de O&M y pueden ser visibles y evaluados por todos los usuarios.

URI

GET /v1/{project_id}/vpc-endpoint-services/public

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID del proyecto.

Mínimo: 1

Máximo: 64

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

limit

No

Integer

Especifica el número máximo de servicios públicos de punto de conexión de VPC que se muestran en cada página. El valor varía de 0 a 1000 y es generalmente 10, 20 o 50. El número predeterminado es 10.

Mínimo: 1

Máximo: 1000

Predeterminado: 10

offset

No

Integer

Especifica el desfase. Todos los servicios de punto de conexión de VPC después de este desfase serán consultados. El desfase debe ser un entero mayor que 0 pero menor que el número de servicios de punto de conexión de VPC.

Mínimo: 0

endpoint_service_name

No

String

Especifica el nombre del servicio público de punto de conexión de VPC. El valor distingue entre mayúsculas y minúsculas y admite coincidencia difusa.

Mínimo: 1

Máximo: 128

id

No

String

ID único del servicio público de punto de conexión de VPC.

Mínimo: 1

Máximo: 64

sort_key

No

String

Especifica el campo de clasificación de los servicios de punto de conexión de VPC, que puede ser: ● crear_at: los servicios de punto de conexión de VPC se ordenan por hora de creación. ● update_at: Los servicios de punto de conexión de VPC se ordenan por hora de actualización. El campo predeterminado es create_at.

Predeterminado: create_at

sort_dir

No

String

Especifica el método de clasificación de los servicios de punto de conexión de VPC, que puede ser: ● desc: los servicios de punto de conexión de VPC se ordenan en orden descendente. ● asc: Los servicios de punto de conexión de VPC se ordenan en orden ascendente. El método predeterminado es desc.

Predeterminado: desc

Parámetros de solicitud

Tabla 3 Parámetros de cabecera de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Especifica el token de usuario. Se puede obtener llamando a la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Mínimo: 1

Máximo: 2048

Content-Type

String

Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor predeterminado application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía según el tipo de flujo.

Mínimo: 1

Máximo: 64

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

endpoint_services

Matriz de objetos de EndpointService

Enumera los servicios de punto de conexión de VPC.

total_count

Integer

Especifica el número total de servicios públicos de punto de conexión de VPC que cumplen los criterios de búsqueda. El número no se ve afectado por los parámetros de límite y desplazamiento.

Tabla 5 EndpointService

Parámetro

Tipo

Descripción

id

String

ID único del servicio público de punto de conexión de VPC.

owner

String

Especifica el propietario del servicio de punto de conexión de VPC.

service_name

String

Especifica el nombre del servicio público de punto de conexión de VPC.

service_type

String

Especifica el tipo del servicio de punto de conexión de VPC. ● gateway: Los servicios de punto de conexión de VPC de este tipo son configurados por el personal de O&M. Pueden usarlos directamente sin crearlos por ustedes mismos. ● interface: Se incluyen los servicios en la nube configurados por el personal de O&M y los servicios privados creados por ustedes mismos. No puede configurar estos servicios en la nube, pero puede usarlos. Puede crear un punto de conexión de VPC para acceder al gateway e interfaz de los servicios de punto de conexión de VPC.

created_at

String

Especifica la hora de creación del servicio de punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MM-DDTHH:MM:SSZ.

is_charge

Boolean

Especifica si el punto de conexión de VPC asociado lleva un cargo. ● true: El punto de conexión de VPC asociado debe ser cargado. ● false: No es necesario que se cargue el punto de conexión de VPC asociado.

Código de estado: 400

Tabla 6 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 7 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 401

Tabla 8 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 9 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 403

Tabla 10 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 11 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 404

Tabla 12 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 13 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 405

Tabla 14 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 15 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 406

Tabla 16 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 17 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 407

Tabla 18 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 19 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 408

Tabla 20 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 21 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 409

Tabla 22 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 23 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 500

Tabla 24 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 25 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 501

Tabla 26 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 27 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 502

Tabla 28 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 29 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 503

Tabla 30 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 31 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Código de estado: 504

Tabla 32 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

error

Objeto de Error

Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

Tabla 33 Error

Parámetro

Tipo

Descripción

message

String

Descripción de error de tarea

code

String

Código de error de una excepción de tarea.

Ejemplo de solicitudes

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

Ejemplo de respuestas

Código de estado: 200

El servidor ha procesado correctamente la solicitud.

{
  "endpoint_services": [
    {
      "id": "b0e22f6f-26f4-461c-b140-d873464d4fa0",
      "owner": "example"
      "service_name": "test123",
      "service_type": "interface",
      "created_at": "2018-09-10T13:13:23Z",
      "is_charge": "true"
    },
	{
      "id": "26391a76-546b-42a9-b2fc-496ec68c0e4d",
      "owner": "example"
      "service_name":  "OBS",
      "service_type": "gateway",
      "created_at": "2019-03-28T09:30:27Z",
      "is_charge": "true"
    }
  ],
  "total_count": 2
}

Códigos de estado

Código de estado

Descripción

200

El servidor ha procesado correctamente la solicitud.

400

El servidor no pudo entender la solicitud debido a una sintaxis mal formada.

401

La página solicitada requiere un nombre de usuario y una contraseña.

403

El servidor entendió la solicitud, pero se niega a cumplirla.

404

El servidor no ha encontrado nada que coincida con el URI de solicitud.

405

El método especificado en la línea de solicitud no está permitido para el recurso identificado por el URI de solicitud.

406

El recurso identificado por la solicitud sólo es capaz de generar entidades de respuesta que tienen características de contenido no aceptables de acuerdo con las cabeceras de aceptación enviadas en la solicitud.

407

El cliente primero debe autenticarse con el proxy.

408

El cliente no produjo una solicitud dentro del tiempo que el servidor estaba preparado para esperar.

409

No se pudo completar la solicitud debido a un conflicto con el estado actual del recurso.

500

Error al completar la solicitud. Anormalidad del servicio.

501

Error al completar la solicitud. El servidor no admite la función solicitada.

502

Error al completar la solicitud. porque el servidor ha recibido una respuesta no válida.

503

Error al completar la solicitud. porque el sistema no está disponible.

504

Fin del tiempo de espera del gateway

Códigos de error

Consulte Códigos de error.