Consulta de recursos por etiqueta

Descripción

Esta API se utiliza para consultar las instancias de base de datos especificadas por etiqueta.

Restricciones

Se puede agregar un máximo de 20 etiquetas a una instancia de base de datos. La clave de la etiqueta debe ser única.

Depuración

Puede depurar esta API en el Explorador de API.

URI

• Formato URI

  POST https://{Endpoint}/v3/{project_id}/instances/action

• Ejemplo de URI

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/action

Solicitudes

• Descripción del parámetro

  Tabla 2 Descripción del parámetro

  Nombre	Tipo	Obligatorio	Descripción
  offset	String	No	La posición del índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro. Si la action está establecida para count, este parámetro no se transfiere. Si la action se establece como filter, este parámetro debe ser un entero positivo. El valor predeterminado es 0, que indica que la consulta comienza desde el primer dato.
  limit	String	No	El número de recursos que se van a consultar. Si la action está establecida para count, este parámetro no se transfiere. Si la action se establece como filter, el rango de valores es de 1 a 100. Si este parámetro no se transfiere, las primeras 100 instancias de base de datos se consultan de forma predeterminada.
  action	String	Sí	El identificador de operación. Si action se establece en filter, las instancias se consultan según los criterios de filtrado de etiquetas. Si la action se establece para count, solo se devuelve el número total de registros.
  matches	Array of objects	No	El campo de búsqueda. Si el valor se deja en blanco, la consulta no se basa en el nombre de instancia o en el ID de instancia. Si el valor no está vacío, consulte Tabla 4.
  tags	Array of objects	No	Las etiquetas incluidas. Cada etiqueta contiene un máximo de 20 claves. Para obtener más información, consulte Tabla 3.

  Tabla 3 descripción de estructura de datos de campo de tags

  Nombre	Tipo	Obligatorio	Descripción
  key	String	Sí	La clave de etiqueta. Contiene un máximo de 36 caracteres Unicode. key no puede estar vacía, una cadena vacía o espacios. Antes de usar la key, elimine espacios de caracteres de un solo byte (SBC) antes y después del valor. NOTA: El conjunto de caracteres de este parámetro no se verifica en el proceso de búsqueda.
  values	Array of strings	Sí	Muestra los valores de etiqueta. Cada valor contiene un máximo de 43 caracteres Unicode y no puede contener espacios. Antes de utilizar values, elimine los espacios SBC antes y después del valor. Si los valores son nulos, indica consultar cualquier valor. Los valores están en relación OR.

  Tabla 4 coincide con la descripción del campo

  Nombre	Tipo	Obligatorio	Descripción
  key	String	Sí	Los criterios de consulta. El valor puede ser instance_name o instance_id, lo que indica que la consulta se basa en el nombre o ID de instancia de instancia.
  value	String	Sí	Nombre o ID de la instancia de base de datos que se va a hacer coincidir. Puede llamar a la API para consultar instancias de base de datos para obtener el nombre o ID de instancia de base de datos. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.

• Ejemplo de solicitud

  Consultar las instancias de base de datos especificadas por etiqueta.

  {
    "offset": "100",
    "limit": "100",
    "action": "filter",
    "matches": [
      {
        "key": "instance_name",
        "value": "test-single"
      }
    ],
    "tags": [
      {
        "key": "key1",
        "values": [
          "value1",
          "value2"
        ]
      }
    ]
  }

  Consultar el número total de recursos.

  {
    "action": "count",
    "tags": [
      {
        "key": "key1",
        "values": [
          "value1",
          "value2"
        ]
      },
      {
        "key": "key2",
        "values": [
          "value1",
          "value2"
        ]
      }
    ],
    "matches": [
      {
        "key": "instance_name",
        "value": "test-single"
      },
       {
        "key": "instance_id",
        "value": "958693039f284d6ebfb177375711072ein02"
      }
    ]
  }

Respuestas

• Descripción del parámetro

  Tabla 5 Descripción del parámetro

  Nombre	Tipo	Descripción
  instances	Array of objects	La lista de instancias. Para más detalles, consulte Tabla 6.
  total_count	Integer	Número total de registros consultados.

  Tabla 6 descripción de la estructura de datos de campo de instancia

  Nombre	Tipo	Descripción
  instance_id	String	El ID de instancia, que se puede obtener llamando a la API para consultar instancias. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.
  instance_name	String	El nombre de la instancia de base de datos.
  tags	Array of objects	La lista de etiquetas. Si no hay ninguna etiqueta en la lista, tags se toman como una matriz vacía. Para obtener más información, consulte Tabla 7.

  Tabla 7 descripción de estructura de datos de campo de tags

  Nombre	Tipo	Descripción
  key	String	La clave de etiqueta. El valor contiene 36 caracteres Unicode y no puede estar en blanco. Conjunto de caracteres: 0-9, A-Z, a-z, "_", y "-".
  value	String	El valor de la etiqueta. El valor contiene un máximo de 43 caracteres Unicode y también puede ser una cadena vacía. Conjunto de caracteres: 0-9, A-Z, a-z, "_", "." y "-".

• Ejemplo de respuesta

  Devuelve las instancias de base de datos especificadas por etiqueta.

  {
    "instances": [
      {
        "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02",
        "instance_name": "test-single",
        "tags": [
          {
            "key": "key1",
            "value": "value1"
          },
          {
            "key": "key2",
            "value": "value1"
          }
        ]
      }
    ]
  }

  Número de registros devueltos.

  {
    "total_count": 4
  }

SDK

Haga clic en Document Database Service DDS SDK para descargar el SDK o ver el documento del SDK. Para saber cómo instalar y autenticar un SDK, lea la sección Usage.

Código de estado

Para obtener más información, consulte Código de estado.

Código de error

Para obtener más información, consulte Código de error.