Consulta los grupos de direcciones IP
Función
Esta API se utiliza para consultar grupos de direcciones IP según criterios de filtro.
URI
GET /v3/{project_id}/vpc/address-groups
| 
        Nombre  | 
      
        Obligatorio  | 
      
        Tipo  | 
      
        Descripción  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Sí  | 
      
        String  | 
      
        ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.  | 
     
| 
        Parámetro  | 
      
        Obligatorio  | 
      
        Tipo  | 
      
        Descripción  | 
     
|---|---|---|---|
| 
        limit  | 
      
        No  | 
      
        Integer  | 
      
        Número de registros mostrados en cada página. Rango de valores: 0 a 2000  | 
     
| 
        marker  | 
      
        No  | 
      
        String  | 
      
        Iniciar ID de recurso de consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página.  | 
     
| 
        id  | 
      
        No  | 
      
        Array of strings  | 
      
        Identificador único de un grupo de direcciones IP, que se puede utilizar para filtrar el grupo de direcciones IP.  | 
     
| 
        name  | 
      
        No  | 
      
        Array of strings  | 
      
        Nombre de un grupo de direcciones IP, que se puede utilizar para filtrar el grupo de direcciones IP.  | 
     
| 
        ip_version  | 
      
        No  | 
      
        Integer  | 
      
        Versión de direcciones IP en un grupo de direcciones IP. El valor puede ser 4 o 6.  | 
     
| 
        description  | 
      
        No  | 
      
        Array of strings  | 
      
        Proporciona información adicional acerca de un grupo de direcciones IP, que se puede utilizar para filtrar el grupo de direcciones IP.  | 
     
Parámetro de solicitud
No hay
Ejemplo de la solicitud
- Consultar grupos de direcciones IP según criterios de filtrado combinados
    
"GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4" 
Parámetro de respuesta
Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:
| 
        Parámetro  | 
      
        Tipo  | 
      
        Descripción  | 
     
|---|---|---|
| 
        request_id  | 
      
        String  | 
      
        ID de solicitud  | 
     
| 
        address_groups  | 
      
        Array of AddressGroup objects  | 
      
        Cuerpo de respuesta de grupos de direcciones IP  | 
     
| 
        page_info  | 
      
        PageInfo object  | 
      
        Información de la paginación  | 
     
| 
        Parámetro  | 
      
        Tipo  | 
      
        Descripción  | 
     
|---|---|---|
| 
        id  | 
      
        String  | 
      
        ID de grupo de direcciones IP, que identifica de forma única al grupo de direcciones IP El valor es una string en formato UUID.  | 
     
| 
        name  | 
      
        String  | 
      
        Nombre del grupo de direcciones IP El valor no puede contener más de 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).  | 
     
| 
        description  | 
      
        String  | 
      
        Proporciona información adicional sobre el grupo de direcciones IP. El valor no puede contener más de 255 caracteres. El valor no puede contener los corchetes angulares (< o >).  | 
     
| 
        ip_set  | 
      
        Array of strings  | 
      
        Conjuntos de direcciones IP en un grupo de direcciones IP Intervalo de valores: una única dirección IP, intervalo de direcciones IP o bloque CIDR El número máximo predeterminado de conjuntos de direcciones IP, incluidas las direcciones IP, los intervalos de direcciones IP y los bloques CIDR, en un grupo de direcciones IP es 20.  | 
     
| 
        ip_version  | 
      
        Integer  | 
      
        Si se trata de un grupo de direcciones IPv4 o IPv6 El valor puede ser: 
  | 
     
| 
        created_at  | 
      
        String  | 
      
        Hora en que se crea el grupo de direcciones IP Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss El tiempo se genera automáticamente.  | 
     
| 
        updated_at  | 
      
        String  | 
      
        Hora en la que se actualizó por última vez el grupo de direcciones IP Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss El tiempo se genera automáticamente.  | 
     
| 
        tenant_id  | 
      
        String  | 
      
        ID del proyecto al que pertenece el grupo de direcciones IP  | 
     
Ejemplo de la respuesta
Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:
{
    "address_groups": [
        {
            "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
            "name": "vkvgykvsvhjaaaa1", 
            "tenant_id": "b2782e6708b8475c993e6064bc456bf8", 
            "ip_version": 4, 
            "ip_set": [
                "192.168.5.0/24", 
                "192.168.3.20-192.168.3.100", 
                "192.168.3.43", 
                "192.168.3.42", 
                "192.168.3.41", 
                "192.168.3.40", 
                "192.168.3.2"
            ], 
            "created_at": "2019-06-28T02:06:38", 
            "updated_at": "2019-06-28T02:14:01", 
            "description": "xxxxxxxxxx"
        }
    ], 
    "page_info": {
        "previous_marker": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
        "current_count": 1
    }, 
    "request_id": "e51fa17c-3259-4122-afb1-9c03d4ef5408"
}
  Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.