Aplicación de una plantilla de parámetros
Función
Esta API se utiliza para aplicar una plantilla de parámetro a una o más instancias de base de datos, grupos o nodos.
Restricciones
- Esta API solo se aplica a DDS de edición de comunidad.
- Esta API es una API asíncrona. Una respuesta correcta no indica que la plantilla de parámetro se ha aplicado correctamente.
URI
- Formato URI
PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply
- Ejemplo
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/apply
- Descripción del parámetro
Tabla 1 Descripción del parámetro Nombre
Obligatorio
Descripción
project_id
Sí
Especifica el ID de proyecto de un inquilino en una región.
config_id
Sí
Especifica el ID de plantilla de parámetro.
- Descripción del encabezado
Tabla 2 Descripción del encabezado Nombre
Obligatorio
Descripción
X-Auth-Token
Sí
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
Sí
Especifica el tipo. El valor es application o json.
Solicitudes
- Descripción del parámetro
Tabla 3 Descripción del parámetro Nombre
Obligatorio
Tipo
Descripción
entity_ids
Sí
Array of strings
Especifica ID de instancia, ID de grupo o ID de nodo.
- Si el tipo de instancia de base de datos es un nodo único, el valor de este parámetro es el objeto de lista del ID de instancia de base de datos.
- Si el tipo de instancia de base de datos es un conjunto de réplicas, el valor de este parámetro es el objeto de lista del ID de instancia de base de datos.
- Si el tipo de instancia es cluster y el tipo de nodo es mongos, el valor del parámetro es el objeto de lista del ID de nodo mongos.
- Si el tipo de instancia es cluster y el tipo de nodo es shard, el valor del parámetro es el objeto de lista del ID del nodo shard.
- Si el tipo de instancia es cluster y el tipo de nodo es config, el valor del parámetro es el objeto de lista del ID de nodo cofig.
- Ejemplo de solicitud
{ "entity_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in06"] }
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 aplicar una plantilla de parámetros.
success
Boolean
Indica si la tarea de aplicación de plantilla de parámetro se ha enviado correctamente.
- Si el valor es true, la tarea se envía correctamente.
- Si el valor es false, no se puede enviar la tarea.
- Ejemplo de respuesta normal
{ "job_id": "69cb9fc2-441d-40b0-8b03-388e711b0f17", "success": true }
- Respuesta anormal
Para más detalles, consulte Resultados de solicitud anormales.
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.