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)> Configuración de parámetros> Modificación de parámetros de una instancia de base de datos especificada
Actualización más reciente 2022-11-07 GMT+08:00

Modificación de parámetros de una instancia de base de datos especificada

Función

Esta API se utiliza para modificar parámetros de una instancia de base de datos especificada.

Restricciones

  • Esta API solo se aplica a DDS de edición de comunidad.
  • Los valores solo se pueden establecer para los parámetros definidos por el sistema y que se pueden modificar.
  • Esta API es una API asíncrona. Una respuesta satisfactoria no indica que los parámetros se han modificado correctamente.

URI

  • Formato URI

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

  • Ejemplo

    https://dds.cn-north-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations

  • Descripción del parámetro
    Tabla 1 Descripción del parámetro

    Nombre

    Obligatorio

    Descripción

    project_id

    Especifica el ID de proyecto de un inquilino en una región.

    instance_id

    Especifica 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.

Solicitudes

  • Descripción del parámetro
    Tabla 2 Descripción del parámetro

    Nombre

    Obligatorio

    Tipo

    Descripción

    entity_id

    String

    Especifica el ID de instancia, el ID de grupo o el ID de nodo, que se pueden obtener llamando a la API para consultar instancias. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.

    Si el tipo de instancia es un nodo único, transfiera el ID de instancia.

    Si el tipo de instancia es un conjunto de réplicas, transfiera el ID de instancia.

    Si el tipo de instancia es de clúster y el tipo de nodo es mongos, transfiera el ID de grupo de nodo mongos.

    Si el tipo de instancia es clúster y el tipo de nodo es shard, transfiera el ID de grupo de nodo shard.

    Si el tipo de instancia es de clúster y el tipo de nodo es config, transfiera el ID de grupo de nodo de configuración.

    values

    Object

    Especifica el valor de plantilla de parámetros definido en función de las plantillas de parámetros predeterminadas.

    Para más detalles, consulte Tabla 3.

    Tabla 3 descripción de la estructura de datos del campo de valores

    Nombre

    Obligatorio

    Tipo

    Descripción

    key

    String

    Especifica el nombre del parámetro.

    Ejemplo: In "cursorTimeoutMillis": "600001", the key value is "cursorTimeoutMillis".

    value

    String

    Especifica el valor del parámetro.

    Ejemplo: In "cursorTimeoutMillis": "600001", the value is "600001".

  • Ejemplo de solicitud
    {
    "entity_id": "33f4bd3e56f34b68a36da1520f88bae1gr02",
    "values": {
    "connPoolMaxConnsPerHost": 605,
    "storage.indexBuildRetry": false,
    "storage.journal.commitIntervalMs": 105,
    "sharding.archiveMovedChunks": true,
    "connPoolMaxShardedConnsPerHost": 605,
    "wiredTigerConcurrentWriteTransactions": 135,
    "disableJavaScriptJIT": false,
    "net.maxIncomingConnections": 405,
    "operationProfiling.slowOpThresholdMs": 105,
    "operationProfiling.mode": "all",
    "security.javascriptEnabled": true,
    "cursorTimeoutMillis": 600005
    }
    }

Respuestas

  • Respuesta normal
    Tabla 4 Descripción del parámetro

    Nombre

    Tipo

    Descripción

    job_id

    String

    Indica el ID de la tarea asincrónica para modificar los parámetros de instancia.

    restart_required

    Boolean

    Indica si es necesario reiniciar la instancia.

    • Si el valor es true, es necesario reiniciar.
    • Si el valor es false, no es necesario reiniciar.
  • Ejemplo de respuesta normal
    {
      "job_id": "fde51b36-c4f5-4424-9ac4-bf286f21e063",
      "restart_required": false 
    }

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.