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> Document Database Service> Referencia de la API> APIs V3.0 (recomendado)> Gestión de instancias de base de datos> Consulta de instancias y detalles

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

Consulta de instancias y detalles

Descripción de la API

Esta API se utiliza para consultar instancias y detalles en función de las condiciones especificadas.

Depuración

Puede depurar esta API en el Explorador de API.

URI

Formato URI
GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value},{key}={value}
Ejemplo de URI
- Consultar todas las instancias y detalles
  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
- Consulta de instancias y detalles basados en criterios de búsqueda
  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&tags=key1=value1,key2=value2

**Tabla 1** Descripción del parámetro
Nombre	Tipo	Obligatorio	Descripción
x-auth-token	string	Sí	User token
project_id	String	Sí	ID de proyecto de un inquilino en una región. Para obtener un ID de proyecto, consulte Obtención de un ID de proyecto.
id	String	No	El ID de instancia, que se puede obtener llamando a la API que se usa para consultar instancias y detalles. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.
name	String	No	El nombre de la instancia de base de datos. Si utiliza un asterisco () al principio del nombre, se devuelven resultados de búsqueda difusos. De lo contrario, se devuelven los resultados exactos. NOTA: El asterisco () es un carácter reservado en el sistema y no se puede utilizar solo.
mode	String	No	El tipo de instancia. Sharding indica la instancia del clúster. ReplicaSet indica la instancia del conjunto de réplicas. Single indica la instancia de nodo único.
datastore_type	String	No	El tipo de base de datos. El valor es DDS-Community.
vpc_id	String	No	El ID de VPC. Para obtener este valor de parámetro, utilice uno de los métodos siguientes: Método 1: Inicie sesión en la consola de VPC y vea el ID de VPC en la página de detalles de VPC. Método 2: Consultar el ID de VPC a través de la API de VPC. Para obtener más información, consulte Consulta de VPC.
subnet_id	String	No	El ID de red de la subred. Para obtener este valor de parámetro, utilice uno de los métodos siguientes: Método 1: Inicie sesión en la consola de VPC y haga clic en la subred de destino en la página Subnets. Puede ver el ID de red en la página mostrada. Método 2: Consultar el ID de red a través de la API de VPC. Para obtener más información, consulte Consulta de subredes.
offset	Integer	No	La posición del índice. La consulta comienza a partir del siguiente tiempo de creación de instancia indexado por este parámetro en un proyecto especificado. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor debe ser superior o igual a 0. Si este parámetro no se transfiere, offset se establece en 0 de forma predeterminada, lo que indica que la consulta comienza desde la última instancia de base de datos creada.
limit	Integer	No	Número máximo permitido de instancias de base de datos. El valor varía de 1 a 100. Si este parámetro no se transfiere, las primeras 100 instancias de base de datos se consultan de forma predeterminada.
tags	String	No	Consulta basada en la clave y el valor de la etiqueta de instancia. {key} indica la clave de la etiqueta, y {value} indica el valor de la etiqueta. Se admite un máximo de 20 pares clave-valor. La clave no puede estar vacía o duplicada, pero el valor puede estar vacío. Para consultar instancias con varias claves y valores de etiquetas, separe los pares clave-valor con comas (,).

Solicitudes

Ninguno

Respuestas

Descripción del parámetro

**Tabla 2** Parámetros de body de respuesta
Nombre	Tipo	Obligatorio	Descripción
instances	Array of objects	Sí	La información de la instancia de base de datos. Para obtener más información, consulte Tabla 3.
total_count	Integer	Sí	Número total de registros consultados.

**Tabla 3** Estructura de datos del campo instancias
Nombre	Tipo	Obligatorio	Descripción
id	String	Sí	El ID de instancia de base de datos.
name	String	Sí	El nombre de la instancia de base de datos.
remark	String	Sí	Observaciones de instancia
status	String	Sí	El estado de la instancia de base de datos. Valores válidos normal: indica que la instancia se está ejecutando correctamente. abnormal: indica que la instancia es anormal. creating: indica que se está creando la instancia. frozen: indica que la instancia está congelada. data_disk_full: El espacio de almacenamiento está lleno. createfail: indica que la instancia no se pudo crear. enlargefail: indica que no se han podido agregar nodos a la instancia. NOTA: Las acciones que se ejecutan en una instancia, por ejemplo, reiniciar, son esencialmente diferentes del estado de la instancia. Para obtener más información, consulte el campo acciones de esta tabla.
port	String	Sí	El puerto de la base de datos. El rango de puertos es de 2100 a 9500.
mode	String	Sí	El tipo de instancia, que es el mismo que el parámetro de solicitud.
region	String	Sí	Región en la que se implementa la instancia de base de datos.
datastore	Object	Sí	La información de la base de datos. Para obtener más información, consulte Tabla 4.
engine	String	Sí	El motor de almacenamiento. DDS soporta los motores de almacenamiento WiredTiger y RocksDB. Si la versión de la base de datos es 4.2 y el motor de almacenamiento es rocksDB, el valor es rocksDB. Si la versión de la base de datos es 4.0 o 3.4 y el motor de almacenamiento es de WiredTiger el valor es de wiredTiger.
created	String	Sí	El tiempo de creación de la instancia de base de datos.
updated	String	Sí	La hora en que se actualiza una instancia de base de datos.
db_user_name	String	Sí	El nombre de usuario predeterminado. El valor es rwuser.
ssl	Integer	Sí	Si SSL está habilitado. 1: indica que SSL está habilitado. 0: indica que SSL está deshabilitado.
vpc_id	String	Sí	El ID de VPC.
subnet_id	String	Sí	El ID de red de la subred.
security_group_id	String	Sí	Indica el ID del grupo de seguridad.
backup_strategy	Object	Sí	La política de copia de respaldo. Para obtener más información, consulte Tabla 5.
pay_mode	String	No	El modo de facturación. 0: indica el modo de facturación de pago por uso. 1: indica el modo de facturación anual/mensual.
maintenance_window	String	Sí	La ventana de tiempo de mantenimiento.
groups	Array of objects	Sí	Información del grupo Para obtener más información, consulte Tabla 6.
disk_encryption_id	String	Sí	ID de la clave de encriptación del disco. Este parámetro se devuelve solo cuando el disco de instancia está cifrado.
enterprise_project_id	String	Sí	ID del proyecto de empresa. Si el valor es 0, el recurso pertenece al proyecto de empresa predeterminado.
time_zone	String	Sí	La zona horaria.
dss_pool_id	String	No	El ID del grupo de almacenamiento DSS del usuario DeC.
actions	Array of strings	Sí	Acción que se está ejecutando en una instancia. Valores válidos RESTARTING: Se está reiniciando la instancia. RESTORE: Se está restaurando la instancia. RESIZE_FLAVOR: Las especificaciones se están modificando. RESTORE_TO_NEW_INSTANCE: Se está restaurando la instancia. MODIFY_VPC_PEER: se está configurando el acceso entre subredes. CREATE: Se está creando la instancia. FROZEN: La instancia está congelada. RESIZE_VOLUME: El almacenamiento se está escalando. RESTORE_CHECK: Se está comprobando la restauración. RESTORE_FAILED_HANGUP: Error en la restauración. CLOSE_AUDIT_LOG: Se está deshabilitando la política de auditoría. OPEN_AUDIT_LOG: se está habilitando la política de auditoría. PERIOD_RESOURCE_SPEC_CHG: Se están verificando los cambios de recursos anuales/mensales. CREATE_IP_SHARD: Se está habilitando la dirección IP del shard. CREATE_IP_CONFIG: La dirección IP de configuración se está habilitando. GROWING: El nodo se está escalando. SET_CONFIGURATION: Los parámetros están siendo modificados. RESTORE_TABLE: La tabla está siendo restaurada. MODIFY_SECURITYGROUP: se está cambiando un grupo de seguridad. BIND_EIP: El EIP está siendo cambiado. UNBIND_EIP: La EIP no está vinculada. SWITCH_SSL: Se está cambiando el SSL. SWITCH_PRIMARY: Se está realizando una conmutación primaria/en espera. CHANGE_DBUSER_PASSWORD: Se está cambiando la contraseña. MODIFY_PORT: Se está cambiando el puerto. MODIFY_IP: Se está cambiando la dirección IP privada. DELETE_INSTANCE: se está eliminando la instancia. REBOOT: Se está reiniciando la instancia. BACKUP: La copia de respaldo está en curso. MIGRATE_AZ: El zona de disponibilidad está siendo cambiado. PWD_RESETING: Se está restableciendo la contraseña. UPGRADE_DATABASE: Se está actualizando el parche. DATA_MIGRATION: Los datos se están migrando. SHARD_GROWING: El fragmento está siendo escalado. APPLY_CONFIGURATION: se está cambiando un grupo de parámetros. RESET_PASSWORD: Se está restableciendo la contraseña. GROWING_REVERT: se están eliminando los nodos. SHARD_GROWING_REVERT: Los fragmentos se están eliminando. ONDEMAND_TO_PERIOD: El modo de facturación se cambia a anual/mensual. LOG_PLAINTEXT_SWITCH: se está modificando la configuración del registro de consultas lentas. CREATE_DATABASE_USER: Se está creando el usuario de la base de datos. CREATE_DATABASE_ROLE: Se está creando el rol de base de datos. MODIFY_NAME: Se está cambiando el nombre. MODIFY_PRIVATE_DNS: Se está modificando la zona privada. MODIFY_OP_LOG_SIZE: se está cambiando el tamaño de oplog. ADD_READONLY_NODES: las réplicas de lectura se están escalando.
order_id	String	No	ID de pedido, que se devuelve solo cuando una instancia se factura anualmente/mensualmente.
tags	Array of objects	Sí	Lista de etiquetas Para más detalles, consulte Tabla 9.

**Tabla 4** Estructura de datos del campo datastore
Nombre	Tipo	Obligatorio	Descripción
type	String	Sí	El motor DB.
version	String	Sí	La versión de la base de datos. Las versiones 4.2, 4.0 y 3.4 son compatibles. El valor puede ser 4.2, 4.0, o 3.4. NOTA: DDS 4.2 está restringido para uso comercial. Para obtener más información, consulte los avisos de DDS. Para asegurarse de que tiene una buena experiencia con DDS, cree una instancia de DDS 4.0.
patch_available	Boolean	Sí	Si hay un parche disponible para la actualización. Si se devuelve true, puede instalar el parche para actualizar la instancia.

**Tabla 5** descripción de la estructura de datos del campo backup_strategy
Nombre	Tipo	Obligatorio	Descripción
start_time	String	Sí	La ventana de tiempo de copia de respaldo. Las copias de respaldo automatizadas se activarán durante la ventana de tiempo de copia de respaldo. La hora actual es la hora UTC.
keep_days	Integer	Sí	El número de días para conservar los archivos de copia de respaldo generados. El intervalo de valores es de 0 a 732.

**Tabla 6** descripción de la estructura de datos de campo de grupos
Nombre	Tipo	Obligatorio	Descripción
type	String	Sí	El tipo de nodo. Valores válidos shard config mongos replica single
id	String	Sí	El ID del grupo. Este parámetro es válido solo cuando el tipo de nodo es shard o config.
name	String	Sí	El nombre del grupo. Este parámetro es válido solo cuando el tipo de nodo es shard o config.
status	String	Sí	El estado del grupo. Este parámetro es válido solo cuando el tipo de nodo es shard o config.
volume	Object	Sí	La información del volumen. Para obtener más información, consulte Tabla 7. Este parámetro es válido solo cuando el tipo de nodo es shard, config o replica
nodes	Array of objects	Sí	La información del nodo. Para obtener más información, consulte Tabla 8.

**Tabla 7** Descripción de la estructura de datos del campo de volumen
Nombre	Tipo	Obligatorio	Descripción
size	String	Sí	El tamaño del disco. Unidad: GB
used	String	Sí	El uso del disco. Unidad: GB

**Tabla 8** nodos campo estructura de datos descripción
Nombre	Tipo	Obligatorio	Descripción
id	String	Sí	El ID de nodo.
name	String	Sí	El nombre del nodo.
status	String	Sí	El estado del nodo.
role	String	Sí	El rol del nodo. Valores válidos master: Este valor se devuelve para el nodo mongos. Primary: Este valor se devuelve para los nodos primarios de fragmento y configuración, y para el nodo primario de un conjunto de réplicas. Secondary: Este valor se devuelve para los nodos secundarios de shard y config, y el nodo secundario de un conjunto de réplicas. Hidden: Este valor se devuelve para los nodos de fragmento y configuración ocultos, y para el nodo oculto de un conjunto de réplicas. unknown. Este valor se devuelve cuando el nodo es anormal.
private_ip	String	Sí	La dirección IP privada de un nodo. By default, this parameter is valid only for mongos nodes and replica set instances. The value exists after the ECS is created successfully. Otherwise, the value is "". ATENCIÓN: Después de habilitar la dirección IP del fragmento o de configuración, las direcciones IP privadas se asignan al fragmento principal y secundario o a los nodos de configuración de la instancia del clúster.
public_ip	String	Sí	La EIP que ha sido vinculada. This parameter is valid only for mongos nodes of cluster instances and the primary and secondary nodes of replica set instances.
spec_code	String	Sí	El código de especificación de recurso. Para obtener más información sobre las especificaciones de instancia, consulte el valor del parámetro flavors.spec_code en Consulta de especificaciones de base de datos.
availability_zone	String	Sí	AZ.

**Tabla 9** Descripción del campo de etiqueta
Nombre	Tipo	Obligatorio	Descripción
key	String	Sí	Clave de etiqueta
value	String	Sí	Valor de la etiqueta

Los valores de region y available_zone se usan como ejemplos.

Ejemplo de respuesta

{
  "instances": [
    {
      "id": "8436a91546294036b75931e879882200in02",
      "name": "dds-efa6",
      "remark": "test",
      "status": "normal",
      "port": 8635,
      "mode": "ReplicaSet",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:05:52",
      "updated": "2019-01-17T07:05:47",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "16:00-17:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": {
        "type": "replica",
        "volume": {
          "size": 10,
          "used": 0.33
        },
        "nodes": [
          {
            "id": "233eaac9c6f245c0bb9c2d21eea12d1bno02",
            "name": "dds-efa6_replica_node_2",
            "status": "normal",
            "role": "Primary",
            "private_ip": "192.168.0.174",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          },
          {
            "id": "d57d76d6320a4a7b86db82c317550c4ano02",
            "name": "dds-efa6_replica_node_1",
            "status": "normal",
            "role": "Hidden",
            "private_ip": "192.168.0.39",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          },
          {
            "id": "f46b0a1cf4d9400e9fd7af17f8742d37no02",
            "name": "dds-efa6_replica_node_3",
            "status": "normal",
            "role": "Secondary",
            "private_ip": "192.168.0.176",
            "public_ip": "",
            "spec_code": "dds.s2.medium.4.shard",
            "availability_zone": "bbb"
          }
        ]
      },
      "enterprise_project_id": "0",
      "time_zone": "",
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    },
    {
      "id": "d77905385f114217b75ae7d6ab9a7588in02",
      "name": "dds-5699",
      "status": "normal",
      "remark": "Test",
      "port": 8635,
      "mode": "Single",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:04:39",
      "updated": "2019-01-17T07:04:33",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "17:00-18:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": {
        "type": "single",
        "volume": {
          "size": 10,
          "used": 0.33
        },
        "nodes": [
          {
            "id": "bd4dccbd53ae48d5bd3046bebf715079no02",
            "name": "dds-5699_single_node_1",
            "status": "normal",
            "role": "Primary",
            "private_ip": "192.168.0.9",
            "public_ip": "",
            "spec_code": "dds.mongodb.c6.medium.4.single",
            "availability_zone": "bbb"
          }
        ]
      },
      "enterprise_project_id": "0",
      "time_zone": "",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    },
    {
      "id": "9136fd2a9fcd405ea4674276ce36dae8in02",
      "name": "dds-32f4",
      "remark": 123,
      "status": "normal",
      "port": 8635,
      "mode": "Sharding",
      "region": "cn-xianhz-1",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "patch_available": false
      },
      "engine": "wiredTiger",
      "created": "2019-01-17T07:04:37",
      "updated": "2019-01-17T07:04:31",
      "db_user_name": "rwuser",
      "ssl": 1,
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy": {
        "start_time": "19:00-20:00",
        "keep_days": 7
      },
      "pay_mode": 0,
      "maintenance_window": "02:00-06:00",
      "groups": [
        {
          "type": "mongos",
          "nodes": [
            {
              "id": "a742c13a284949adad177672e8a0f01cno02",
              "name": "dds-32f4_mongos_node_1",
              "status": "normal",
              "role": "Primary",
              "private_ip": "192.168.0.56",
              "public_ip": "",
              "spec_code": "dds.mongodb.c6.medium.4.mongos",
              "availability_zone": "bbb"
            },
            {
              "id": "d4f66666b1d64ab28719da0526341c7eno02",
              "name": "dds-32f4_mongos_node_2",
              "status": "normal",
              "role": "Primary",
              "private_ip": "192.168.0.185",
              "public_ip": "",
              "spec_code": "dds.mongodb.c6.medium.4.mongos",
              "availability_zone": "bbb"
            }
          ]
        },
        {
          "type": "shard",
          "volume": {
            "size": 10,
            "used": 0.33
          },
          "nodes": [
            {
              "id": "0e9abaebe5974b63a5b221de6ee34cfeno02",
              "name": "dds-32f4_shard_2_node_3",
              "status": "normal",
              "role": "Primary",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            },
            {
              "id": "1d7f4c5476c04cc187f920925c2b601fno02",
              "name": "dds-32f4_shard_2_node_2",
              "status": "normal",
              "role": "Hidden",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            },
            {
              "id": "3dd2cce03da54fc08f10651cbfea778dno02",
              "name": "dds-32f4_shard_2_node_1",
              "status": "normal",
              "role": "Secondary",
              "spec_code": "dds.mongodb.c6.medium.4.shard",
              "availability_zone": "bbb"
            }
          ]
        },
        {
          "type": "config",
          "volume": {
            "size": 10,
            "used": 0.33
          },
          "nodes": [
            {
              "id": "7422f7331b714ac39aa647a1ec968d33no02",
              "name": "dds-32f4_config_node_2",
              "status": "normal",
              "role": "Primary",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            },
            {
              "id": "9e3b343151044eda91ddb8a42ae5cbefno02",
              "name": "dds-32f4_config_node_3",
              "status": "normal",
              "role": "Hidden",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            },
            {
              "id": "c0053ca460ac4889841ffb14a886ec54no02",
              "name": "dds-32f4_config_node_1",
              "status": "normal",
              "role": "Secondary",
              "spec_code": "dds.mongodb.c6.large.2.config",
              "availability_zone": "bbb"
            }
          ]
        }
      ],
      "enterprise_project_id": "0",
      "time_zone": "",
      "actions": [
        "CREATE"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    }
  ],
  "total_count": 3
}