Consulta de los puertos entrantes personalizados de un gateway
Función
Esta API se utiliza para consultar los puertos entrantes personalizados de un gateway.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
|
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
|
protocol |
No |
String |
Protocolo de solicitud de puertos de entrada.
|
|
ingress_port |
No |
Integer |
Número de puerto de entrada. El valor oscila entre 1024 y 49151. Mínimo: 1024 Máximo: 49151 |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
size |
Integer |
Longitud de la lista de recursos devuelta. |
|
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
|
ingress_port_infos |
Array of IngressPortInfo objects |
Puertos de entrada personalizados. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
protocol |
String |
Protocolo de puerto de entrada personalizado.
|
|
ingress_port |
Integer |
Número de puerto de entrada. El valor oscila entre 1024 y 49151. Mínimo: 1024 Máximo: 49151 |
|
ingress_port_id |
String |
ID del puerto de entrada. Mínimo: 32 Máximo: 36 |
|
status |
String |
Estado del puerto entrante personalizado.
|
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 1,
"size" : 1,
"ingress_port_infos" : [ {
"protocol" : "HTTP",
"ingress_port" : 8080,
"ingress_port_id" : "0ae98839d78043d8a6dff54d7cb096dc",
"status" : "normal"
} ]
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Aceptar |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.