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.
Actualización más reciente 2022-11-07 GMT+08:00

Listado de todas las instancias

Función

Esta API se utiliza para consultar las instancias de una cuenta según las condiciones especificadas.

URI

GET /v2/{project_id}/instances

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID del proyecto.

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

engine

No

String

Motor de mensajes. Valor: kafka.

name

No

String

Nombre de instancia.

instance_id

No

String

ID de instancia.

status

No

String

Estado de la instancia.

include_failure

No

String

Si se debe devolver el número de instancias que no se pueden crear.

Si el valor es true, se devuelve el número de instancias que no se han creado. Si el valor no es true, el número no se devuelve.

exact_match_name

No

String

Si se debe buscar la instancia que coincide exactamente con un nombre de instancia especificado.

El valor predeterminado es false*, que indica que se realiza una búsqueda difusa basada en un nombre de instancia especificado. Si el valor es true, se consulta la instancia que coincide exactamente con un nombre de instancia especificado.

enterprise_project_id

No

String

ID del proyecto de empresa.

Parámetros de solicitud

Ninguno

Parámetros de respuesta

Código de estado: 200

Tabla 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

instances

Matriz de objetos ShowInstanceResp

Lista de instancias.

instance_num

Integer

Número de instancias.

Tabla 4 ShowInstanceResp

Parámetro

Tipo

Descripción

name

String

Nombre de instancia.

engine

String

Motor de mensajes.

engine_version

String

Versión.

description

String

Descripción de la instancia

specification

String

Especificaciones de instancia.

storage_space

Integer

Espacio de almacenamiento de mensajes en GB.

partition_num

String

Número de particiones en una instancia de Kafka.

used_storage_space

Integer

Espacio de almacenamiento de mensajes usado en GB.

connect_address

String

Dirección IP de una instancia.

port

Integer

Puerto de una instancia.

status

String

Estado de la instancia. Para obtener más información, consulte "Estado de la instancia" (en https://support.huaweicloud.com/intl/en-us/api-kafka/kafka-api-180514012.html).

instance_id

String

ID de instancia.

resource_spec_code

String

Código de especificaciones de recursos.

  • dms.instance.kafka.cluster.c3.mini: Instancia de Kafka con ancho de banda de 100 MB/s
  • dms.instance.kafka.cluster.c3.small.2: Instancia de Kafka con ancho de banda de 300 MB/s
  • dms.instance.kafka.cluster.c3.middle.2: Instancia de Kafka con ancho de banda de 600 MB/s
  • dms.instance.kafka.cluster.c3.high.2: Instancia de Kafka con ancho de banda de 1200 MB/s

charging_mode

Integer

Modo de facturación. Opciones: 1: pago por uso; 0: anual/mensual.

vpc_id

String

ID de VPC.

vpc_name

String

Nombre de VPC.

created_at

String

Hora en la que se creó la instancia.

La hora tiene el formato de marca de tiempo, es decir, el desplazamiento de milisegundos desde 1970-01-01 00:00:00 UTC a la hora especificada.

subnet_name

String

Nombre de subred.

subnet_cidr

String

Bloque CIDR de subred.

user_id

String

ID de usuario.

user_name

String

Nombre de usuario.

access_user

String

Nombre de usuario para acceder a la instancia.

order_id

String

ID de pedido. Este parámetro tiene un valor solo cuando el modo de facturación es anual/mensual.

maintain_begin

String

Hora en la que comienza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss.

maintain_end

String

Hora en la que finaliza la ventana de tiempo de mantenimiento. El formato es HH:mm:ss.

enable_publicip

Boolean

Si el acceso público está habilitado para la instancia.

  • true: habilitado
  • false: deshabilitado

management_connect_address

String

Dirección de conexión de Kafka Manager de la instancia de Kafka.

ssl_enable

Boolean

Si la autenticación de seguridad está habilitada.

  • true: habilitada
  • false: deshabilitada

ssl_two_way_enable

Boolean

Indica si se debe habilitar la autenticación bidireccional.

cert_replaced

Boolean

Si se puede reemplazar el certificado.

public_management_connect_address

String

Dirección para acceder a Kafka Manager a través de redes públicas.

enterprise_project_id

String

ID del proyecto de empresa.

is_logical_volume

Boolean

Si la instancia es una instancia nueva. Este parámetro se utiliza para distinguir las instancias antiguas de las nuevas durante la expansión de la capacidad de la instancia.

  • true: Nueva instancia, que permite la expansión dinámica de la capacidad del disco sin reiniciar la instancia.
  • false: Instancia antigua.

extend_times

Integer

Número de veces de expansión del disco. Si el valor supera 20, ya no se permite la expansión del disco.

enable_auto_topic

Boolean

Si la creación automática de temas está habilitada.

  • true: habilitada
  • false: deshabilitada

type

String

Tipo de instancia. El valor puede ser cluster.

product_id

String

ID del producto.

security_group_id

String

ID del grupo de seguridad.

security_group_name

String

Nombre del grupo de seguridad.

subnet_id

String

ID de subred.

available_zones

Matriz de strings

AZ a la que pertenecen los agentes de instancia. Se devuelve el ID de AZ.

total_storage_space

Integer

Espacio de almacenamiento de mensajes en GB.

public_connect_address

String

Dirección de acceso público de instancia. Este parámetro sólo está disponible cuando el acceso público está habilitado para la instancia.

storage_resource_id

String

ID de recurso de almacenamiento.

storage_spec_code

String

Especificaciones de E/S.

service_type

String

Tipo de servicio.

storage_type

String

Clase de almacenamiento.

retention_policy

String

Política de retención de mensajes.

kafka_public_status

String

Si el acceso público está habilitado para Kafka.

public_bandwidth

Integer

Ancho de banda de acceso a la red pública.

kafka_manager_user

String

Nombre de usuario para iniciar sesión en Kafka Manager.

enable_log_collection

Boolean

Si la recopilación de registros está habilitada.

cross_vpc_info

String

Información de acceso entre VPC.

ipv6_enable

Boolean

Si IPv6 está habilitado.

ipv6_connect_addresses

Matriz de strings

Dirección de conexión de IPv6.

connector_enable

Boolean

Si el volcado está habilitado. El volcado no es compatible con el nuevo tipo de especificación.

connector_id

String

ID de tarea de volcado.

rest_enable

Boolean

Si Kafka REST está habilitado.

rest_connect_address

String

Dirección de conexión de Kafka REST.

public_boundwidth

Integer

Ancho de banda de acceso a la red pública. Por eliminar.

message_query_inst_enable

Boolean

Si la consulta de mensajes está habilitada.

vpc_client_plain

Boolean

Si el acceso de texto sin formato intra-VPC está habilitado.

support_features

String

Lista de características admitidas por la instancia de Kafka.

trace_enable

Boolean

Si el seguimiento de mensajes está habilitado.

agent_enable

Boolean

Indica si el proxy está habilitado.

pod_connect_address

String

Dirección de conexión en el lado del inquilino.

disk_encrypted

Boolean

Si el cifrado de disco está habilitado.

disk_encrypted_key

String

Clave de cifrado de disco. Si el cifrado de disco no está habilitado, este parámetro se deja en blanco.

kafka_private_connect_address

String

Dirección de conexión privada de una instancia de Kafka.

ces_version

String

Versión de Cloud Eye.

public_access_enabled

String

Hora en la que se ha habilitado el acceso público para una instancia. El valor puede ser true, actived, closed, or false.

node_num

Integer

Cantidad de nodos.

enable_acl

Boolean

Indica si el control de acceso está habilitado.

new_spec_billing_enable

Boolean

Si está habilitada la facturación basada en nuevas especificaciones.

broker_num

Integer

Cantidad de agentes.

tags

Matriz de objetos TagEntity

Lista de etiquetas.

dr_enable

Boolean

Indica si DR está habilitado.

Tabla 5 TagEntity

Parámetro

Tipo

Descripción

key

String

Clave de etiqueta, que puede contener un máximo de 36 caracteres Unicode.

La clave no puede dejarse en blanco ni ser una cadena vacía.

No puede contener caracteres ASCII no imprimibles (0–31) ni los siguientes caracteres especiales: =*<>,|/

value

String

Valor de etiqueta, que puede contener un máximo de 43 caracteres Unicode.

El valor no se puede dejar en blanco ni ser una cadena vacía.

No puede contener caracteres ASCII no imprimibles (0–31) ni los siguientes caracteres especiales: =*<>,|/

Solicitudes de ejemplo

GET https://{endpoint}/v2/{project_id}/instances

Respuestas de ejemplo

Ninguno

Códigos de estado

Código de estado

Descripción

200

Todas las instancias se enumeran correctamente.

Códigos de error

Consulte Códigos de error.