Modificación de especificaciones de instancia de base de datos
Descripción de la API
Esta API se utiliza para modificar las especificaciones de instancia en la misma o en diferentes series de instancia.
Los servicios se interrumpirán durante 5 a 10 minutos cuando modifique las especificaciones de instancia de base de datos. Tenga cuidado al realizar esta operación.
Reglas de cambio
Tabla 1 enumera las especificaciones a las que se puede cambiar cada especificación de instancia. Tenga cuidado al realizar esta operación. Una vez cambiada la especificación de instancia, no se puede volver a cambiar.
Especificación original |
Especificación del destino |
Soportado |
---|---|---|
General-purpose |
General-purpose |
√ |
Enhanced |
× |
|
Enhanced II |
√ |
|
Enhanced |
General-purpose |
√ |
Enhanced |
× |
|
Enhanced II |
√ |
|
Enhanced II |
General-purpose |
× |
Enhanced |
× |
|
Enhanced II |
√ |
√ indica que se admite un elemento y × indica que no se admite un elemento.
Restricciones
- Esta API admite instancias de base de datos anuales/mensuales y de pago por uso.
- Si desea cambiar las especificaciones a otras especificaciones de la misma serie, las nuevas especificaciones no pueden ser las mismas que las especificaciones originales.
- Las especificaciones sólo se pueden modificar cuando el estado de la instancia de base de datos es normal.
Depuración
Puede depurar esta API en Explorador de API.
URI
Nombre |
Tipo |
IN |
Obligatorio |
Descripción |
---|---|---|---|---|
x-auth-token |
string |
header |
Sí |
Token de usuario. |
project_id |
string |
path |
Sí |
Especifica el ID de proyecto de un inquilino en una región. |
instance_id |
string |
path |
Sí |
Especifica el ID de instancia, que se puede obtener llamando a la API para consultar instancias. Si no tienes una instancia, puedes llamar a API para crear una instancia. |
Solicitudes
- Descripción del parámetro
Tabla 3 Descripción del parámetro Nombre
Tipo
Obligatorio
Descripción
resize
Object
Sí
La información de especificación. Para obtener más información, consulte Tabla 4.
is_auto_pay
Boolean
No
Si el pedido se paga automáticamente desde su cuenta cuando cambia la clase de una instancia de base de datos anual/mensual. Este parámetro no afecta al modo de pago de la renovación automática.
- Este parámetro no es válido cuando se reduce la escala de la clase de instancia.
- Cuando se escala la clase de instancia, este parámetro se puede establecer en:
- true: indica que el pedido se paga automáticamente desde la cuenta.
- false: indica que el pedido se paga manualmente desde la cuenta. El valor predeterminado es false.
Tabla 4 Descripción de la estructura de datos del campo de cambio de tamaño Nombre
Tipo
Obligatorio
Descripción
target_type
String
No
El tipo de objeto:
- Este parámetro es obligatorio para una instancia de clúster. Si modifica las especificaciones de un nodo mongos, el valor es mongos. Si modifica las especificaciones de un nodo de fragmento, el valor es shard. Si modifica las especificaciones de un nodo config, el valor es config.
- Este parámetro no se transfiere para el conjunto de réplicas y las instancias de nodo único.
target_id
String
Sí
ID del nodo o instancia cuyas especificaciones se van a modificar. Puede obtener el ID llamando a la API utilizada para consultar instancias. Si no tiene una instancia, puede llamar a API utilizada para crear una instancia.
- Si modifica las especificaciones de un nodo mongos, el valor es el ID del nodo mongos. Si modifica las especificaciones de un nodo de shard, el valor es el ID del nodo de shard. Si modifica las especificaciones de un nodo de configuración, el valor es el ID del nodo de configuración.
- Para una instancia de conjunto de réplicas, el valor es el ID de instancia de base de datos.
- Para una instancia de nodo único, el valor es el ID de instancia de base de datos.
target_spec_code
String
Sí
El código de especificación de recurso de la nueva especificación. Para obtener más información acerca de cómo obtener el valor, vea los valores de respuesta de flavors.spec_code en Consulta de especificaciones de base de datos.
- Ejemplo de solicitud
Modifique las especificaciones del nodo mongos.
{ "resize": { "target_type": "mongos", "target_id": "a742c13a284949adad177672e8a0f01cno02", "target_spec_code": "dds.mongodb.c6.large.4.mongos" } }
Modifique las especificaciones del nodo de fragmento.
{ "resize": { "target_type": "shard", "target_id": "aeeb40a704904977ad78993d138ec942gr02", "target_spec_code": "dds.momgodb.c6.large.4.shard" } }
Modifique las especificaciones del nodo de configuración.
{ "resize": { "target_type": "config", "target_id": "10a1c330537b42c1a9b3f7a5ebcda35egr02", "target_spec_code": "dds.momgodb.c6.xlarge.2.config" } }
Modifique las especificaciones de un conjunto de réplicas o de una instancia de nodo único.{ "resize": { "target_id": "aeeb40a704904977ad78993d138ec942in02", "target_spec_code": "dds.mongodb.c6.medium.4.repset" } }
Respuestas
- Descripción del parámetro
Tabla 5 Descripción del parámetro Nombre
Tipo
Obligatorio
Descripción
job_id
String
Sí
ID de la tarea.
order_id
String
No
El ID de la orden. Este parámetro se devuelve solo cuando se cambian las especificaciones de una instancia de base de datos anual/mensual.
- Ejemplo de respuesta
{ "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" }
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.