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

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

Función

Esta API se utiliza para obtener información sobre los parámetros de una instancia de base de datos especificada.

Restricciones

Esta API solo se aplica a DDS de edición de comunidad.

URI

  • Formato URI

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations?entity_id={entity_id}

  • Ejemplo

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f0ba99dd8a8249838a6007042d76b07ain02/configurations?entity_id=827697ee2f6040bd9fcf65586e3f7218gr02

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

    entity_id

    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.
  • Descripción del encabezado
    Tabla 2 Descripción del encabezado

    Nombre

    Obligatorio

    Descripción

    X-Auth-Token

    Especifica el token de usuario obtenido del servicio IAM. Para más detalles, consulte Autenticación.

    X-Language

    No

    Especifica el tipo de idioma de solicitud, como en-us. El valor no distingue entre mayúsculas y minúsculas.

    Content-Type

    Especifica el tipo. El valor es application o json.

Solicitudes

Ninguno

Respuestas

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

    Nombre

    Tipo

    Descripción

    datastore_version_name

    String

    Indica el nombre de la versión de la base de datos.

    datastore_name

    String

    Indica el nombre de la base de datos.

    created

    String

    Indica la hora de creación en el formato "aaaa-MM-ddTHH:mm:ssZ".

    T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.

    updated

    String

    Tiempo de actualización en el formato "aaaa-MM-ddTHH:mm:ssZ".

    T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800.

    configuration_parameters

    Array of objects

    Indica los parámetros definidos por los usuarios basados en las plantillas de parámetros por defecto.

    Para más detalles, consulte Tabla 4.

    Tabla 4 descripción de la estructura de datos del campo configuration_parameters

    Nombre

    Tipo

    Descripción

    name

    String

    Indica el nombre del parámetro.

    value

    String

    Indica el valor del parámetro.

    restart_required

    Boolean

    Indica si es necesario reiniciar la instancia de base de datos.

    • Si el valor es false, no es necesario reiniciar.
    • Si el valor es true, es necesario reiniciar.

    readonly

    Boolean

    Indica si el grupo de parámetros es de sólo lectura.

    • Si el valor false, el parámetro no es de sólo lectura.
    • Si el valor es true, el parámetro es de sólo lectura.

    value_range

    String

    Indica el rango de valores. Por ejemplo, el valor del tipo entero oscila entre 0 y 1, y el valor del tipo Booleano es true o false.

    type

    String

    Indica el tipo de parámetro. El valor puede ser string, integer, boolean, list, o float.

    description

    String

    Indica la descripción del parámetro.

  • Ejemplo de respuesta normal
{
"datastore_version_name": "4.0",
"datastore_name": "mongodb",
"created": "2021-04-19T02:43:00+0000",
"updated": "2021-04-19T09:15:31+0000",
"configuration_parameters": [
{
"name": "connPoolMaxConnsPerHost",
"value": "601",
"restart_required": true,
"readonly": false,
"value_range": "200-2000",
"type": "integer",
"description": "Maximum size of the connection pools for connections to other mongod instances."
},
{
"name": "connPoolMaxShardedConnsPerHost",
"value": "600",
"restart_required": true,
"readonly": false,
"value_range": "200-2000",
"type": "integer",
"description": "Maximum size of the connection pools for communication between mongos or shard and the other shards in the cluster."
},
{
"name": "cursorTimeoutMillis",
"value": "600000",
"restart_required": false,
"readonly": false,
"value_range": "600000-1000000",
"type": "integer",
"description": "Expiration threshold for idle cursors before DDS removes them."
},
{
"name": "net.maxIncomingConnections",
"value": "default",
"restart_required": true,
"readonly": false,
"value_range": "200-8000",
"type": "integer",
"description": "Maximum number of simultaneous connections that mongos or mongod will accept. The default value depends on system architecture."
},
{
"name": "security.clusterAuthMode",
"value": "x509",
"restart_required": true,
"readonly": true,
"value_range": "sendX509|x509",
"type": "string",
"description": "The authentication mode used for cluster authentication."
},
{
"name": "userCacheInvalidationIntervalSecs",
"value": "30",
"restart_required": true,
"readonly": false,
"value_range": "1-86400",
"type": "integer",
"description": "Interval in seconds at which mongos checks whether the in-memory cache of user objects has stale data."
}
]
}

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.