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/ Distributed Message Service for Kafka/ Referencia de la API/ API fuera de fecha/ API V1/ API para gestionar instancias/ Consulta de todas las instancias

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

Ver PDF

Consulta de todas las instancias

Esta API está desactualizada y es posible que no se mantenga en el futuro. Utilice la API descrita en Listado de todas las instancias.

Función

Esta API se utiliza para consultar las instancias de un tenant por condiciones establecidas.

URI

GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}&enterprise_project_id={enterprise_project_id}

Tabla 1 describe los parámetros.

**Tabla 1** Parámetros
Parámetro	Tipo	Obligatorio	Descripción
project_id	String	Sí	Indica el ID de un proyecto.
engine	String	No	Indica el motor de mensajes. Valor: kafka
name	String	No	Indica el nombre de instancia.
id	String	No	Indica el ID de instancia.
status	String	No	Indica el estado de la instancia. Para más detalles, consulte Estado de la instancia.
includeFailure	String	No	Indica si se devuelve 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.
exactMatchName	String	No	Indica si se debe buscar la instancia que coincide exactamente con un nombre de instancia especificado. El valor predeterminado es false, lo 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	String	No	Indica el ID del proyecto de empresa.

Solicitud.

Parámetros de solicitud

No hay.

Solicitud de ejemplo

GET https://{dms_endpoint}/v1.0/{project_id}/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false

Respuesta

Parámetros de respuesta

Tabla 2 describe los parámetros.

**Tabla 2** Parámetros de respuesta
Parámetro	Tipo	Descripción
instances	Array	Indica los detalles de la instancia.
instance_num	Integer	Indica el número de instancias.

**Tabla 3** descripción del parámetro de instancia
Parámetro	Tipo	Descripción
name	String	Indica el nombre de instancia.
engine	String	Indica el motor de mensajes.
engine_version	String	Indica la versión del motor.
specification	String	Indica las especificaciones de una instancia.
storage_space	Integer	Indica el espacio de almacenamiento del mensaje. Unidad: GB
partition_num	String	Indica el número máximo de temas en una instancia de Kafka.
used_storage_space	Integer	Indica el espacio de almacenamiento de mensajes utilizado. Unidad: GB
connect_address	String	Indica la dirección IP de una instancia.
port	Integer	Indica el número de puerto de una instancia.
status	String	Indica el estado de una instancia. Para más detalles, consulte Estado de la instancia.
instance_id	String	Indica el ID de instancia.
resource_spec_code	String	Indica el identificador de especificaciones de recursos. dms.instance.kafka.cluster.c3.mini: instancia de Kafka, ancho de banda de referencia de 100 MB/s dms.instance.kafka.cluster.c3.small.2: instancia de Kafka, ancho de banda de referencia de 300 MB/s dms.instance.kafka.cluster.c3.middle.2: instancia de Kafka, ancho de banda de referencia de 600 MB dms.instance.kafka.cluster.c3.high.2: instancia de Kafka, ancho de banda de referencia de 1200 MB
charging_mode	Integer	Modo de facturación.
vpc_id	String	Indica el ID de una VPC.
vpc_name	String	Indica el nombre de una VPC.
created_at	String	Indica la hora a la que se crea una instancia. La hora tiene el formato de marca de tiempo, es decir, el offset de milisegundos desde 1970-01-01 00:00:00 UTC a la hora especificada.
user_id	String	Indica el ID de usuario.
user_name	String	Indica el nombre de usuario.
order_id	String	Indica el ID de pedido.
maintain_begin	String	Indica la hora en la que se inicia una ventana de tiempo de mantenimiento. Formato: HH: mm: ss
maintain_end	String	Tiempo en el que finaliza la ventana de tiempo de mantenimiento. Formato: HH: mm: ss
enable_publicip	Boolean	Indica si se debe habilitar el acceso público para una instancia. true: habilitar false: deshabilitar
management_connect_address	String	Indica la dirección de conexión del Kafka Manager de una instancia de Kafka.
ssl_enable	Boolean	Indica si se debe habilitar la autenticación de seguridad. true: habilitar false: deshabilitar
enterprise_project_id	String	Indica el ID del proyecto de empresa.
is_logical_volume	Boolean	Distingue 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	Indica el número de veces de expansión del disco. Si excede de 20, el disco no puede expandirse.
enable_auto_topic	Boolean	Indica si está habilitada la creación automática de temas. true: habilitar false: deshabilitar
type	String	Indica el tipo de instancia. Valor: cluster.
product_id	String	Indica el ID del producto.
security_group_id	String	Indica el ID del grupo de seguridad.
security_group_name	String	Indica el nombre del grupo de seguridad.
subnet_id	String	Indica el ID de subred.
available_zones	Array	Indica la AZ a la que pertenece el nodo de instancia. Se devuelve el ID de AZ.
total_storage_space	Integer	Indica el espacio de almacenamiento del mensaje. Unidad: GB
public_connect_address	String	Indica la dirección IP de la instancia para el acceso público. Este parámetro sólo se muestra cuando el acceso público está habilitado.
storage_resource_id	String	Indica el ID del recurso de almacenamiento.
storage_spec_code	String	Indica la especificación de E/S.
service_type	String	Indica el tipo de servicio.
storage_type	String	Indica el tipo de almacenamiento.
retention_policy	String	Indica la política de retención de mensajes.
kafka_public_status	String	Indica si el acceso público de Kafka está habilitado.
public_bandwidth	Integer	Indica el ancho de banda de la red pública.
kafka_manager_user	String	Indica el nombre de usuario para iniciar sesión en Kafka Manager.
enable_log_collection	Boolean	Indica si la recopilación de logs está habilitada.
cross_vpc_info	String	Indica información de acceso entre VPC.
ipv6_enable	Boolean	Indica si IPv6 está habilitado.
ipv6_connect_addresses	Array of strings	Indica la dirección de conexión IPv6.
connector_enable	Boolean	Indica si está habilitado el volcado.
connector_id	String	Indica el ID de la tarea de volcado.
rest_enable	Boolean	Indica si la función REST de Kafka está habilitada.
rest_connect_address	String	Indica la dirección REST de Kafka.
message_query_inst_enable	Boolean	Indica si la consulta de mensajes está habilitada.
vpc_client_plain	Boolean	Indica si el acceso de texto sin formato dentro de VPC está habilitado.
support_features	String	Indica la lista de características admitidas por la instancia de Kafka.
trace_enable	Boolean	Indica si el seguimiento de mensajes está habilitado.
pod_connect_address	String	Indica la dirección de conexión en el lado del tenant.
disk_encrypted	Boolean	Indica si el encriptación de disco está habilitado.
kafka_private_connect_address	String	Indica la dirección de conexión privada de una instancia de Kafka.
ces_version	String	Indica la versión de Cloud Eye.
tags	Array<Object>	Indica la lista de etiquetas.

**Tabla 4** Etiquetas
Parámetro	Tipo	Descripción
key	String	Indica la clave de etiqueta.
value	String	Indica el valor de la etiqueta.

Ejemplo de respuesta

{
    "instances": [
        {
            "name": "kafka-l00230526",
            "engine": "kafka",
            "port": 9092,
            "status": "RUNNING",
            "type": "cluster",
            "specification": "100MB",
            "engine_version": "XXX",
            "connect_address": "192.168.1.116,192.168.1.152,192.168.1.78",
            "instance_id": "ef84dd5f-3ece-4336-8c99-987defd62e3a",
            "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
            "charging_mode": 1,
            "vpc_id": "2477879f-aebf-496f-a08a-67812885ce9b",
            "vpc_name": "vpc-y00502467",
            "created_at": "1568797295209",
            "product_id": "00300-30308-0--0",
            "security_group_id": "008a08e2-10cc-4d9b-90ab-3f3b8f6c3333",
            "security_group_name": "z00417080-cce-node-na7j",
            "subnet_id": "5ca08fb7-7522-4d95-9fa5-ff6b3592a29d",
            "available_zones": [
                "ae04cf9d61544df3806a3feeb401b204"
            ],
            "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
            "user_name": "laiyh",
            "kafka_manager_user": "root",
            "maintain_begin": "22:00",
            "maintain_end": "02:00",
            "storage_space": 492,
            "total_storage_space": 600,
            "used_storage_space": 25,
            "partition_num": "300",
            "ssl_enable": false,
            "management_connect_address": "https://192.168.1.116:9999",
            "storage_resource_id": "81982562-ce8b-490a-95fa-2b225c292271",
            "storage_spec_code": "dms.physical.storage.ultra",
            "service_type": "advanced",
            "storage_type": "hec",
            "enterprise_project_id": "0",
            "is_logical_volume": true,
            "extend_times": 0,
            "retention_policy": "produce_reject",
            "ipv6_enable": false,
            "ipv6_connect_addresses": [],
            "rest_enable": false,
            "rest_connect_address": "",
            "message_query_inst_enable": true,
            "vpc_client_plain": false,
            "support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
            "trace_enable": false,
            "agent_enable": false,
            "pod_connect_address": "100.113.16.105:9100,100.113.5.197:9100,100.113.15.231:9100",
            "disk_encrypted": false,
            "enable_auto_topic": true
        }
    ],
    "instance_num": 1
}