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 IP/ Referencia de la API/ Las API/ Ancho de banda/ Consulta de anchos de banda

Actualización más reciente 2022-11-08 GMT+08:00

Ver PDF

Consulta de anchos de banda

Función

Esta API se utiliza para consultar anchos de banda mediante criterios de búsqueda.

URI

GET /v1/{project_id}/bandwidths

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.
marker	No	String	Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza desde el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el límite de parámetro. Si no se pasan los parámetros de marcador y límite, se devolverán los registros de recursos de la primera página. Si el marcador de parámetro no se pasa y el valor del límite de parámetro se establece en 10, se devolverán los primeros 10 registros de recursos. Si el valor del marcador de parámetro se establece en el ID de recurso del 10º registro y el valor del límite de parámetro se establece en 10, se devolverán los registros de recursos del 11º al 20º. Si el valor del marcador de parámetro se establece en el ID de recurso del 10º registro y no se pasa el límite de parámetro, se devolverán los registros de recursos que comienzan desde el 11º registro (incluido el 11º).
limit	No	Integer	Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax. se puede utilizar junto con el marcador. Para obtener más información, consulte la descripción de parámetros del marcador.
share_type	No	String	Especifica el tipo de ancho de banda. Los valores posibles son los siguientes: PER: Ancho de banda dedicado WHOLE: Ancho de banda compartido Si este parámetro no está definido, la lista de todos los anchos de banda se devolverá por defecto.
enterprise_project_id	No	String	Especifica el ID del proyecto de empresa. Este campo se puede utilizar para filtrar las VPC asociadas a un proyecto de empresa especificado. El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado. Para obtener las VPC enlazadas a todos los proyectos de empresa del usuario, establezca all_granted_eps.

Mensaje de solicitud

Parámetro de solicitud

**Tabla 2** Parámetro de cabecera de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Ejemplo de la solicitud

GET https://{Endpoint}/v1/{project_id}/bandwidths?limit={limit}&marker={marker}

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 3** Parámetro de respuesta
Nombre	Tipo	Descripción
bandwidths	Array of bandwidths objects	Especifica los objetos de ancho de banda. Para más detalles, consulte Tabla 4.

**Tabla 4** Descripción del campo **bandwidths**
Nombre	Tipo	Descripción
name	String	Especifica el nombre del ancho de banda. El valor puede contener de 1 a 64 caracteres, incluyendo letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
size	Integer	Especifica el tamaño de ancho de banda en Mbit/s. El valor varía de 1 Mbit/s a 300 Mbit/s de forma predeterminada. (El rango específico puede variar dependiendo de la configuración en cada región. Puede ver el rango de ancho de banda de cada región en la consola de gestión.)
id	String	Especifica el identificador de ancho de banda, que identifica de forma exclusiva el ancho de banda.
share_type	String	Especifica si el ancho de banda es compartido o dedicado. Los valores posibles son los siguientes: PER: Ancho de banda dedicado WHOLE: Ancho de banda compartido Si este parámetro no está definido, la lista de todos los anchos de banda se devolverá por defecto.
publicip_info	Array of publicip_info objects	Especifica la información sobre el EIP que utiliza el ancho de banda. Para más detalles, consulte Tabla 5. El ancho de banda, cuyo tipo es WHOLE, puede ser utilizado por múltiples EIPs (hasta 20 EIPs por defecto). El ancho de banda, cuyo tipo es PER, puede ser utilizado por un solo EIP.
tenant_id	String	Especifica el ID del proyecto.
bandwidth_type	String	Especifica el tipo de ancho de banda. El valor puede ser: share: Ancho de banda compartido. bgp: BGP dinámico sbgp: BGP estático
charge_mode	String	Especifica si el ancho de banda se factura por el tráfico o por el tamaño del ancho de banda. Los valores posibles pueden ser bandwidth (facturado por ancho de banda) y traffic (facturado por tráfico). Si el valor es una string de caracteres vacía o no se especifica ningún valor, se utiliza el valor bandwidth.
billing_info	String	Especifica la información de la lista. Si se especifica billing_info, el ancho de banda está en modo de facturación anual/mensual.
enterprise_project_id	String	Especifica el ID del proyecto de empresa. El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado. Para obtener el ancho de banda enlazado a todos los proyectos de empresa del usuario, establezca all_granted_eps. Al crear un ancho de banda, asocie el ID del proyecto de empresa con el ancho de banda.
status	String	Especifica el estado del ancho de banda. Possible values are as follows: FREEZED (Congelado) NORMAL (Normal)
created_at	String	Especifica la hora (UTC) en la que se crea el ancho de banda. Formato: yyyy-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) cuando se actualiza el ancho de banda. Formato: yyyy-MM-ddTHH:mm:ss
enable_bandwidth_rules	boolean	Especifica si se activa QoS. El valor puede ser true o false.
rule_quota	integer	Especifica el número máximo de reglas de agrupación admitidas por el ancho de banda.
bandwidth_rules	Array of bandwidth_rules objects	Especifica las reglas de ancho de banda.
public_border_group	String	Especifica si se encuentra en una ubicación central o en una ubicación de borde. Valores: center Edge site name Este recurso solo puede asociarse con un EIP de la misma región.

**Tabla 5** Objeto **publicip_info**
Nombre	Tipo	Descripción
publicip_id	String	Especifica el ID de EIP que utiliza el ancho de banda.
publicip_address	String	Especifica el EIP obtenido si sólo están disponibles los EIP IPv4.
publicipv6_address	String	Especifica el EIP obtenido si los EIP IPv6 están disponibles. Este parámetro no existe si solo están disponibles EIP IPv4.
ip_version	Integer	Especifica la versión de la dirección IP. Los valores posibles son los siguientes: 4: IPv4 6: IPv6
publicip_type	String	Especifica el tipo de EIP. El valor puede ser 5_bgp (BGP dinámico) o 5_sbgp (BGP estático). CN South-Guangzhou: 5_bgp y 5_sbgp CN East-Shanghai1: 5_bgp y 5_sbgp CN East-Shanghai2: 5_bgp y 5_sbgp CN North-Beijing1: 5_bgp y 5_sbgp CN-Hong Kong: 5_bgp AP-Bangkok: 5_bgp AP-Singapore: 5_bgp AF-Johannesburg: 5_bgp CN Southwest-Guiyang1: 5_sbgp CN North-Beijing4: 5_bgp y 5_sbgp LA-Santiago: 5_bgp LA-Sao Paulo1: 5_bgp LA-Mexico City1: 5_bgp LA-Buenos Aires1: 5_bgp LA-Lima1: 5_bgp LA-Santiago2: 5_bgp Restricciones: El valor configurado debe ser compatible con el sistema. publicip_id es un puerto IPv4. Si no se especifica publicip_type, el valor predeterminado es 5_bgp.

**Tabla 6** Objeto **bandwidth_rules**
Nombre	Tipo	Descripción
id	string	Especifica el ID de regla de ancho de banda.
name	string	Especifica el nombre de la regla de ancho de banda.
admin_state_up	boolean	Especifica el estado de configuración. El valor False indica que la configuración no tiene efecto.
egress_size	integer	Especifica el ancho de banda de salida máximo en Mbit/s. El intervalo de valores varía de 0 a n, donde n indica el tamaño de ancho de banda compartido. Si el valor se establece en 0, se utilizará el ancho de banda máximo, es decir, el tamaño de ancho de banda compartido.
egress_guarented_size	integer	Especifica el ancho de banda de salida garantizado en Mbit/s. El valor varía de 0 a x, donde x indica el ancho de banda restante.
publicip_info	Array of publicip_info objects	Especifica el EIP asociado al ancho de banda. El ancho de banda, cuyo tipo se establece en WHOLE, puede ser utilizado por múltiples EIP. El ancho de banda, cuyo tipo se establece en PER, sólo puede ser utilizado por un EIP.

Ejemplo de la respuesta

{
  "bandwidths": [
    {
      "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
      "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
      "size": 200,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "2a65923c-7133-415d-ae3b-cf9635a942c5",
          "publicip_address": "10.xx.xx.3",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
      "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
      "size": 300,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "c754bc9a-16d5-4763-9674-d7561917aa80",
          "publicip_address": "10.xx.xx.9",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0a673f00-3640-4a13-949e-7049b2916baf",
      "name": "bandwidth123",
      "size": 10,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "cec7fb70-2f82-4561-bd83-2121fb642fdc",
          "publicip_address": "10.xx.xx.184",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    },
    {
      "id": "0dde1eae-1783-46dc-998c-930fbe261ff9",
      "name": "bandwidth123",
      "size": 100,
      "share_type": "PER",
      "publicip_info": [
        {
          "publicip_id": "24232038-e178-40ad-80e4-5abb75db84be",
          "publicip_address": "10.xx.xx.101",
          "ip_version": 4,
          "publicip_type": "5_bgp",
        }
      ],
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "bandwidth_type": "bgp",
      "charge_mode": "bandwidth",
      "billing_info": "",
      "enterprise_project_id": "0"
      "status": "NORMAL",
      "enable_bandwidth_rules": false,
      "rule_quota": 0,
      "bandwidth_rules": [],
    }
  ]
}