Consulta de la lista de paquetes de ancho de banda
Función
Esta API se utiliza para consultar la lista de paquetes de ancho de banda. Los parámetros marker y limit se utilizan para la consulta de paginación. Los dos parámetros solo tienen efecto cuando se usan juntos.
URI
GET /v3/{domain_id}/ccaas/bandwidth-packages
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| domain_id | Sí | String | ID de cuenta. Mínimo: 10 Máximo: 32 |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| limit | No | Integer | Número de los registros devueltos en cada página durante una consulta de paginación. Mínimo: 1 Máximo: 2000 Predeterminado: 2000 |
| marker | No | String | ID del último registro de la página anterior. Si este parámetro se deja en blanco, se consultan los recursos de la primera página. Este parámetro debe usarse junto con limit. Mínimo: 0 Máximo: 36 |
| id | No | Array | ID utilizado para consultar los paquetes de ancho de banda. |
| name | No | Array | Nombre utilizado para consultar los paquetes de ancho de banda. |
| status | No | Array | Estado del paquete de ancho de banda. ACTIVE: los paquetes de ancho de banda están disponibles. Predeterminado: ACTIVE |
| enterprise_project_id | No | Array | ID de proyecto de empresa utilizado para consultar los paquetes de ancho de banda. |
| billing_mode | No | Array | Modo de facturación utilizado para consultar los paquetes de ancho de banda. |
| resource_id | No | Array | ID de conexión en la nube utilizado para consultar los paquetes de ancho de banda. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Token de usuario. Mínimo: 0 Máximo: 102400 |
Parámetros de respuesta
Código de estado: 200
| Parámetro | Tipo | Descripción |
|---|---|---|
| bandwidth_packages | Array of BandwidthPackage objects | Lista de paquetes de ancho de banda. |
| page_info | PageInfo object | Información de consulta de paginación. |
| request_id | String | ID de solicitud. Mínimo: 0 Máximo: 36 |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID del paquete de ancho de banda. Mínimo: 0 Máximo: 36 |
| name | String | Nombre del paquete de ancho de banda. Mínimo: 1 Máximo: 64 |
| description | String | Descripción del paquete de ancho de banda. Mínimo: 0 Máximo: 85 |
| domain_id | String | ID de cuenta. Mínimo: 0 Máximo: 36 |
| enterprise_project_id | String | ID del proyecto de empresa al que pertenece el paquete de ancho de banda. Predeterminado: 0 Mínimo: 0 Máximo: 36 |
| status | String | Estado del paquete de ancho de banda. ACTIVE: los paquetes de ancho de banda están disponibles. Mínimo: 0 Máximo: 36 |
| created_at | String | La hora en la que se creó el paquete de ancho de banda. |
| updated_at | String | La hora en la que se actualizó el paquete de ancho de banda. |
| admin_state_up | Boolean | Estado administrativo del paquete de ancho de banda. |
| order_id | String | ID de pedido del paquete de ancho de banda. Mínimo: 0 Máximo: 32 |
| product_id | String | ID de producto del paquete de ancho de banda. Mínimo: 0 Máximo: 36 |
| spec_code | String | Código de especificación del paquete de ancho de banda.
Mínimo: 0 Máximo: 32 |
| billing_mode | String | Modo de facturación del paquete de ancho de banda en el sitio web de China continental o el sitio web Internacional.
|
| charge_mode | String | Opción de facturación del paquete de ancho de banda. El paquete de ancho de banda se factura por ancho de banda. Mínimo: 0 Máximo: 64 |
| bandwidth | Integer | Ancho de banda en el paquete de ancho de banda. Mínimo: 2 Máximo: 999999 |
| resource_id | String | ID del recurso al que está enlazado el paquete de ancho de banda. Mínimo: 0 Máximo: 36 |
| resource_type | String | Tipo del recurso al que está enlazado el paquete de ancho de banda. cloud_connection: Conexión a la nube. Mínimo: 0 Máximo: 32 |
| local_area_id | String | La región geográfica. Cloud Connect está disponible en las siguientes regiones geográficas:
Mínimo: 0 Máximo: 32 |
| remote_area_id | String | La otra región geográfica. Cloud Connect está disponible en las siguientes regiones geográficas:
Mínimo: 0 Máximo: 32 |
| project_id | String | ID del proyecto. Mínimo: 0 Máximo: 36 |
| interflow_mode | String | Aplicabilidad del paquete de ancho de banda.
Mínimo: 0 Máximo: 32 |
| tags | Array of Tag objects | Lista de etiquetas. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| key | String | Clave de etiqueta. Mínimo: 1 Máximo: 128 |
| value | String | Valor de la etiqueta. Mínimo: 0 Máximo: 255 |
| Parámetro | Tipo | Descripción |
|---|---|---|
| next_marker | String | Marcador de la página siguiente. El valor es el UUID del recurso. Si el marcador se deja en blanco, se consultan los recursos de la última página. Mínimo: 0 Máximo: 36 |
| previous_marker | String | Marcador de la página anterior. El valor es el UUID del recurso. Si el marcador se deja en blanco, se consultan los recursos de la primera página. Mínimo: 0 Máximo: 36 |
| current_count | Integer | Número de los recursos en la lista. Mínimo: 0 Máximo: 2000 |
Ejemplo de las solicitudes
Consulta de los paquetes de ancho de banda
GET https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages Ejemplo de las respuestas
Código de estado: 200
Se ha consultado la lista de paquetes de ancho de banda.
{
"request_id" : "61126320a1802d5c6444f9d2d76526c2",
"bandwidth_packages" : [ {
"bandwidth" : 5,
"status" : "ACTIVE",
"id" : "XXXXX",
"name" : "test_bwp_name",
"description" : "",
"domain_id" : "XXX",
"created_at" : "2022-12-06T01:37:15Z",
"updated_at" : "2022-12-06T01:37:15Z",
"project_id" : "XXX",
"resource_type" : "",
"resource_id" : "",
"local_area_id" : "Chinese-Mainland",
"remote_area_id" : "Chinese-Mainland",
"admin_state_up" : true,
"charge_mode" : "bandwidth",
"billing_mode" : "3",
"spec_code" : "bandwidth.cmtocm",
"order_id" : "",
"product_id" : "",
"enterprise_project_id" : "0",
"tags" : [ ],
"interflow_mode" : "Area"
} ],
"page_info" : {
"next_marker" : "XXX",
"previous_marker" : "XXX",
"current_count" : 1
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | Se ha consultado la lista de paquetes de ancho de banda. |
Códigos de error
Consulte Códigos de error.