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/ Elastic Load Balance/ Referencia de la API/ API del balanceador de carga dedicado/ Grupo de direcciones IP/ Consulta de grupos de direcciones IP
Actualización más reciente 2022-11-17 GMT+08:00
Ver PDF
Compartir

Consulta de grupos de direcciones IP

Función

Esta API se utiliza para consultar grupos de direcciones IP. Esta función no se admite en la región eu-nl. Por favor, no lo use.

Restricciones

Esta API tiene las siguientes restricciones:

  • Los parámetros marker, limit y page_reverse se utilizan para la consulta de paginación.
  • Los parámetros marker y page_reverse solo tienen efecto cuando se usan junto con el parámetro limit.

URI

GET /v3/{project_id}/elb/ipgroups

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

Especifica el ID del proyecto.
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

marker

No

String

Especifica el identificador del último registro de la página anterior.

Nota:

  • Este parámetro debe usarse junto con limit.
  • Si no se especifica este parámetro, se consultará la primera página.
  • Este parámetro no se puede dejar en blanco ni establecer un ID no válido.

limit

No

Integer

Especifica el número de registros de cada página.

Mínimo: 0

Máximo: 2000

Predeterminado: 2000

page_reverse

No

Boolean

Especifica si se va a utilizar la consulta inversa. Valores:

  • true: consulta la página anterior.
  • false (predeterminado): consulta la página siguiente.

Nota:

  • Este parámetro debe usarse junto con limit.
  • Si page_reverse se establece en true y desea consultar la página anterior, establezca el valor de marker en el valor de previous_marker.

id

No

Array

Especifica el ID del grupo de direcciones IP.

name

No

Array

Especifica el nombre del grupo de direcciones IP.

description

No

Array

Proporciona información adicional sobre el grupo de direcciones IP.

ip_list

No

Array

Muestra las direcciones IP del grupo de direcciones IP. Varias direcciones IP se separan con comas.

Parámetros de solicitud

Tabla 3 Parámetros de cabecera de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Especifica el token utilizado para la autenticación IAM.

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

ipgroups

Array of IpGroup objects

Muestra los grupos de direcciones IP devueltos.

request_id

String

Especifica el ID de la solicitud. El valor se genera automáticamente.

page_info

PageInfo object

Muestra información de paginación.
Tabla 5 IpGroup

Parámetro

Tipo

Descripción

created_at

String

Especifica la hora a la que se creó el grupo de direcciones IP.

description

String

Especifica la hora a la que se actualizó el grupo de direcciones IP.

id

String

Especifica el ID del grupo de direcciones IP.

ip_list

Array of IpInfo objects

Especifica las direcciones IP o bloques CIDR en el grupo de direcciones IP. [] indica cualquier dirección IP.

listeners

Array of ListenerRef objects

Muestra los identificadores de oyentes con los que está asociado el grupo de direcciones IP.

name

String

Especifica el nombre del grupo de direcciones IP.

project_id

String

Especifica el ID de proyecto del grupo de direcciones IP.

updated_at

String

Especifica la hora a la que se actualizó el grupo de direcciones IP.
Tabla 6 IpInfo

Parámetro

Tipo

Descripción

ip

String

Especifica las direcciones IP del grupo de direcciones IP.

IPv6 no es compatible. No introduzca direcciones IPv6.

description

String

Proporciona comentarios sobre el grupo de direcciones IP.

Mínimo: 0

Máximo: 255
Tabla 7 ListenerRef

Parámetro

Tipo

Descripción

id

String

Especifica el ID de oyente.
Tabla 8 PageInfo

Parámetro

Tipo

Descripción

previous_marker

String

Especifica el ID del primer registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página anterior.

next_marker

String

Especifica el ID del último registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página siguiente.

current_count

Integer

Especifica el número de registros.

Ejemplo de las solicitudes

Consulta de grupos de direcciones IP en cada página

GET https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups?limit=1

Ejemplo de las respuestas

Código de estado: 200

Solicitud exitosa.

{
  "ipgroups" : [ {
    "description" : "",
    "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
    "name" : "test_ipg",
    "project_id" : "45977fa2dbd7482098dd68d0d8970117",
    "ip_list" : [ {
      "ip" : "192.168.1.123",
      "description" : ""
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    } ],
    "listeners" : [ {
      "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
    }, {
      "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
    } ],
    "created_at" : "2018-01-16T03:19:16",
    "updated_at" : "2018-01-16T03:19:16"
  } ],
  "page_info" : {
    "previous_marker" : "1d321f77-bc7b-45d3-9cfe-d7c0b65a3620",
    "current_count" : 1
  },
  "request_id" : "8d9f423c-8766-4b6a-9952-275a88ac1ce3"
}

Códigos de estado

Código de estado

Descripción

200

Solicitud exitosa.

Códigos de error

Consulte Códigos de error.

Tema principal: Grupo de direcciones IP