Creación de una instancia de base de datos

Descripción de la API

Esta API se utiliza para crear instancias de clústeres y conjuntos de réplicas.

Restricciones

Esta API admite instancias de base de datos anuales/mensuales y de pago por uso.

Depuración

Puede depurar esta API en Explorador de API.

URI

• Formato URI

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

• Ejemplo de URI

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

Solicitudes

• Descripción del parámetro

  Tabla 2 Descripción del parámetro

  Nombre	Tipo	Obligatorio	Descripción
  name	String	Sí	El nombre de la instancia de base de datos. El nombre de instancia puede ser el mismo que un nombre existente. El nombre de instancia debe contener entre 4 y 64 caracteres y debe comenzar con una letra. Es sensible a mayúsculas y minúsculas y puede contener letras, dígitos, guiones (-) y guiones bajos (_). No puede contener otros caracteres especiales.
  datastore	Object	Sí	La información de la base de datos. Para más detalles, consulte Tabla 3.
  region	String	Sí	El ID de región. El valor no puede estar vacío. Para obtener más información sobre cómo obtener este valor de parámetro, consulte Regiones y puntos de conexión.
  availability_zone	String	Sí	El ID de zona de disponibilidad. Puede seleccionar varias Zonas de disponibilidad para crear un clúster entre AZ basado en az_status devuelto por la API descrita en Consulta de especificaciones de base de datos. El valor no puede estar vacío. Para obtener más información sobre cómo obtener este valor de parámetro, consulte Regiones y puntos de conexión.
  vpc_id	String	Sí	El ID de VPC. Para obtener este valor de parámetro, utilice uno de los métodos siguientes: Método 1: Inicie sesión en la consola de VPC y vea el ID de VPC en la página de detalles de VPC. Método 2: Consultar el ID de VPC a través de la API de VPC. Para obtener más información, consulte Consulta de VPC.
  subnet_id	String	Sí	El ID de red de la subred. Para obtener este valor de parámetro, utilice uno de los métodos siguientes: Método 1: Inicie sesión en la consola de VPC y haga clic en la subred de destino en la página Subnets. Puede ver el ID de red en la página mostrada. Método 2: Consultar el ID de red a través de la API de VPC. Para obtener más información, consulte Consulta de subredes.
  security_group_id	String	Sí	El ID del grupo de seguridad. Para obtener el ID del grupo de seguridad, realice uno de los métodos siguientes: Método 1: Inicie sesión en la consola de VPC. Seleccione Access Control > Security Groups en el panel de navegación de la izquierda. En la página mostrada, haga clic en el grupo de seguridad de destino. Puede ver el ID del grupo de seguridad en la página mostrada. Método 2: Consultar el grupo de seguridad a través de la API de VPC. Para obtener más información, consulte Consulta de grupos de seguridad.
  port	String	No	Puerto de acceso a la base de datos Rango de valores: 2100-9500, 27017, 27018, y 27019. Si este parámetro no se transfiere, el puerto de la instancia de base de datos creada es 8635 de forma predeterminada.
  password	String	No	La contraseña de la base de datos. El valor debe tener una longitud de 8 a 32 caracteres y contener letras mayúsculas (de A a Z), minúsculas (de A a Z), dígitos (0 a 9) y caracteres especiales, como ~!@#%^*-_=+? Ingrese una contraseña segura para mejorar la seguridad, evitando riesgos de seguridad como el agrietamiento por fuerza bruta. Si este parámetro no se transfiere, establezca una contraseña para la instancia antes de conectarse a la instancia. Para obtener más información, consulte Restablecimiento de la contraseña del administrador.
  disk_encryption_id	String	No	El ID de clave utilizado para el encriptación de disco. La cadena debe cumplir con las reglas de expresión regular UUID. Si este parámetro no se transfiere, no se realiza el encriptación del disco.
  mode	String	Sí	El tipo de instancia. Se admiten instancias de clúster y conjunto de réplicas. Valores válidos Sharding ReplicaSet Single
  configurations	Array of objects	No	Información de configuración del grupo de parámetros. Para más detalles, consulte Tabla 4. Si este parámetro no se transfiere, se utiliza el grupo de parámetros predeterminado.
  flavor	Array of objects	Sí	Las especificaciones de la instancia. Para obtener más información, consulte Tabla 5. Para obtener más información sobre cómo obtener el valor, consulte los valores de respuesta de flavor en Consulta de especificaciones de base de datos.
  backup_strategy	Object	No	La política de copia de respaldo avanzada. Para obtener más información, consulte Tabla 6.
  enterprise_project_id	String	No	ID del proyecto de empresa. Este parámetro no se transfiere para los usuarios que no han habilitado el servicio multiproyecto de empresa. Si este parámetro no se transfiere para un usuario que ha habilitado el servicio de varios proyectos de empresa, el valor es el proyecto de empresa predeterminado. Para obtener el ID del proyecto empresarial, consulte el valor de id en la tabla de enterprise_project field data structure en la sección "Consultar la lista de proyectos empresariales" de la Enterprise Management API Reference.
  ssl_option	String	No	Especifica si habilitar o deshabilitar SSL. Valores válidos El valor 0 indica que SSL está deshabilitado de forma predeterminada. El valor 1 indica que SSL está habilitado de forma predeterminada. Si este parámetro no se transfiere, SSL está deshabilitado de forma predeterminada.
  dss_pool_id	String	No	El ID de almacenamiento dedicado del usuario de DeC. El valor se deja en blanco de forma predeterminada. Solo los usuarios de DeC admiten este parámetro.
  server_group_policies	Array of strings	No	Los nombres de las directivas asociadas con el grupo ECS del usuario DeC. Solo los usuarios de DeC admiten este parámetro. Los valores son los siguientes: anti-affinity indica que la implementación anti-afinidad está habilitada para la instancia DDS. Para garantizar la alta disponibilidad, los nodos primario, secundario y oculto se crean en diferentes máquinas físicas. Si este parámetro no se especifica para los usuarios de diciembre, la implementación antiafinidad está deshabilitada de forma predeterminada.
  tags	Array of objects	No	Etiquetas Se puede añadir un máximo de 20 etiquetas para cada instancia. Para más detalles, consulte Tabla 7.
  charge_info	Object	No	Modo de facturación, que incluye anual/mensual y pago por uso. El modo de facturación predeterminado es pago por uso. Para más detalles, consulte Tabla 8.

  Tabla 3 Estructura de datos del campo datastore

  Nombre	Tipo	Obligatorio	Descripción
  type	String	Sí	El tipo de base de datos. El valor es DDS-Community.
  version	String	Sí	La versión de la base de datos. Las versiones 4.2, 4.0 y 3.4 son compatibles. El valor puede ser 4.2, 4.0, o 3.4. NOTA: DDS 4.2 está restringido para uso comercial. Para obtener más información, consulte los avisos de DDS. Para asegurarse de que tiene una buena experiencia con DDS, cree una instancia de DDS 4.0.
  storage_engine	String	Sí	El motor de almacenamiento. DDS soporta los motores de almacenamiento WiredTiger y RocksDB. Si la versión de la base de datos es 4.2 y el motor de almacenamiento es rocksDB, el valor es rocksDB. Si la versión de la base de datos es 4.0 o 3.4 y el motor de almacenamiento es de WiredTiger el valor es de wiredTiger.

  Tabla 4 Estructura de datos del campo Configuraciones

  Parámetro	Tipo	Obligatorio	Descripción
  type	String	Sí	Tipo de nodo. Valores válidos Para una instancia de clúster, el valor puede ser mongos, shard, o config. Para una instancia de conjunto de réplicas, el valor es replica. Para una instancia de nodo único, el valor es single. Valores enumerados: mongos shard config replica single
  configuration_id	String	Sí	ID del grupo de parámetros. Para más detalles, consulte Tabla 4.

  Tabla 5 Estructura de datos del campo de variante

  Nombre	Tipo	Obligatorio	Descripción
  type	String	Sí	El tipo de nodo. Valores válidos Para una instancia de clúster, el valor puede ser mongos, shard, o config. Para una instancia de conjunto de réplicas, el valor es replica. Para una instancia de nodo único, el valor es single.
  num	String	Sí	Número de nodos o grupos. Valores válidos Si el valor de type es mongos, num indica el número de nodos mongos en la instancia del clúster. El valor varía de 2 a 16. Si el valor de type es shard, num indica el número de grupos de shard en la instancia del clúster. El valor varía de 2 a 16. Si el valor de type es config, num indica el número de grupos de configuración en la instancia del clúster. El valor solo puede ser 1. Si el valor de type es replica, num indica el número de nodos de réplica en la instancia del conjunto de réplicas. El valor puede ser 3, 5 o 7. Si el valor de type es single, num indica el número de nodos en una instancia de nodo único. El valor solo puede ser 1.
  storage	String	No	El tipo de disco. Valor válido: ULTRAHIGH, que indica el tipo SSD. Este parámetro es válido para los nodos shard y config de una instancia de clúster y para instancias de conjuntos de réplicas. Este parámetro no es válido para los nodos mongos. Por lo tanto, no es necesario especificar el espacio de almacenamiento para los nodos mongos.
  size	String	No	El tamaño del disco. Este parámetro es obligatorio para todos los nodos excepto mongos. Este parámetro no es válido para los nodos mongos. El valor debe ser un múltiplo de 10. La unidad es GB. Para una instancia de clúster, el espacio de almacenamiento de un nodo de fragmento puede ser de 10 a 2,000 GB, y el espacio de almacenamiento de configuración es de 20 GB. Este parámetro no es válido para los nodos mongos. Por lo tanto, no es necesario especificar el espacio de almacenamiento para los nodos mongos. Para una instancia de conjunto de réplicas, el valor oscila entre 10 y 3000. Para una instancia de nodo único, el valor varía de 10 a 1000.
  spec_code	String	Sí	El código de especificación de recurso. Para obtener más información acerca de cómo obtener el valor, vea los valores de respuesta de spec_code en Consulta de especificaciones de base de datos. En una instancia de clúster, es necesario especificar varias especificaciones. Todas las especificaciones deben ser de la misma serie, es decir, de uso general (s6), mejorado (c3) o mejorado II (c6). Ejemplo: dds.mongodb.s6.large.4.mongos y dds.mongodb.s6.large.4.config tienen las mismas especificaciones. dds.mongodb.s6.large.4.mongos y dds.mongodb.c3.large.4.config no tienen las mismas especificaciones.

  Tabla 6 Estructura de datos del campo backup_strategy

  Nombre	Tipo	Obligatorio	Descripción
  start_time	String	Sí	La ventana de tiempo de copia de respaldo. Las copias de respaldo automatizadas se activarán durante la ventana de tiempo de copia de respaldo. El valor no puede estar vacío. Debe ser un valor válido en el formato "hh:mm-HH:MM". La hora actual está en el formato UTC. El valor HH debe ser 1 mayor que el valor hh. Los valores de mm y MM deben ser los mismos y deben establecerse en 00. Si este parámetro no se transfiere, la ventana de tiempo de copia de respaldo predeterminada se establece en 00:00-01:00. Valor de ejemplo: 23:00-00:00
  keep_days	String	No	El número de días para conservar los archivos de copia de respaldo generados. El intervalo de valores es de 0 a 732. Si este parámetro se establece en 0, la política de copia de respaldo automatizada no se establece. Si este parámetro no se transfiere, la política de copia de respaldo automatizada está habilitada de forma predeterminada. Los archivos de copia de seguridad se almacenan durante siete días de forma predeterminada.

  Tabla 7 Estructura de datos del campo de etiquetas

  Nombre	Tipo	Obligatorio	Descripción
  key	String	Sí	Clave de etiqueta. El valor puede contener un máximo de 36 caracteres unicode. La clave no se puede dejar en blanco ni una cadena vacía. El conjunto de caracteres es el siguiente: A-Z, a-z, 0-9, guiones (-) y caracteres Unicode (\u4E00-\u9FFF).
  value	String	Sí	Valor de la etiqueta. Contiene un máximo de 43 caracteres Unicode. El valor puede ser una cadena vacía. El conjunto de caracteres es el siguiente: A-Z, a-z, 0-9, guiones (-) y caracteres Unicode (\u4E00-\u9FFF).

  Tabla 8 Estructura de datos del campo ChargeInfo

  Parámetro	Tipo	Obligatorio	Descripción
  charge_mode	String	Sí	Modo de facturación. Rango de valores: prePaid: indica el modo de facturación anual/mensual. postPaid: indica el modo de facturación de pago por uso.
  period_type	String	No	Periodo de suscripción. Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Rango de valores: month: El servicio se suscribe por mes. year: El servicio se suscribe por año.
  period_num	Integer	No	Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Rango de valores: Si period_type se establece en month, el valor del parámetro oscila entre 1 y 9. Si period_type se establece en year, el valor del parámetro varía de 1 a 3.
  is_auto_renew	Boolean	No	Si la renovación automática está habilitada para instancias anuales/mensuales. El período de renovación es el mismo que el período original y el pedido se pagará automáticamente durante la renovación de la suscripción. Rango de valores: true: indica que la suscripción se renueva automáticamente. false: indica que la suscripción no se renueva automáticamente. El valor predeterminado es false.
  is_auto_pay	Boolean	No	Forma de pago. Al crear una instancia de base de datos anual/mensual, puede especificar si debe pagar automáticamente con su cuenta. Este parámetro no afecta al método de pago de la renovación automática. Rango de valores: true: indica que la tarifa se paga automáticamente desde la cuenta. false: indica que la tarifa se paga manualmente desde la cuenta. Este método de pago se utiliza por defecto.

Los valores de region y available_zone se usan como ejemplos.

• Ejemplo de solicitud

  Crear una instancia de clúster:

  {
    "name": "test-cluster-01",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.2",
      "storage_engine": "wiredTiger"
    },
    "region": "aaa",
    "availability_zone": "az1xahz",
    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "password": "******",
    "mode": "Sharding",
    "configurations": [
      {
        "type": "mongos",
        "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
      },
      {
        "type": "shard",
        "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
      },
      {
        "type": "config",
        "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
      }
    ],
    "flavor": [
      {
        "type": "mongos",
        "num": 2,
        "spec_code": "dds.mongodb.c6.medium.4.mongos"
      },
      {
        "type": "shard",
        "num": 2,
        "storage": "ULTRAHIGH",
        "size": 20,
        "spec_code": "dds.mongodb.c6.medium.4.shard"
      },
      {
        "type": "config",
        "num": 1,
        "storage": "ULTRAHIGH",
        "size": 20,
        "spec_code": "dds.mongodb.c6.large.2.config"
      }
    ],
    "backup_strategy": {
      "start_time": "08:15-09:15",
      "keep_days": 8
    },
    "ssl_option": 1,
    "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
    "server_group_policies": [
      "anti-affinity"
    ],
    "tags": [
      {
        "key": "dds001",
        "value": "dds001"
      }
    ]
  }

  Cree una instancia de clúster entre AZ.

  {
    "name": "test-cluster-01",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.4",
      "storage_engine": "wiredTiger"
    },
    "region": "aaa",
    "availability_zone": "aaa,bbb,ccc",
    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "password": "******",
    "mode": "Sharding",
    "flavor": [
      {
        "type": "mongos",
        "num": 2,
        "spec_code": "dds.mongodb.c6.medium.4.mongos"
      },
      {
        "type": "shard",
        "num": 2,
        "storage": "ULTRAHIGH",
        "size": 20,
        "spec_code": "dds.mongodb.c6.medium.4.shard"
      },
      {
        "type": "config",
        "num": 1,
        "storage": "ULTRAHIGH",
        "size": 20,
        "spec_code": "dds.mongodb.c6.large.2.config"
      }
    ],
    "backup_strategy": {
      "start_time": "23:00-00:00",
      "keep_days": "8"
    },
    "ssl_option":"1",
    "tags" : [{ 
      "key" : "dds001", 
      "value" : "dds001" 
    }]
  }

  Cree una instancia de conjunto de réplicas.

  {
    "name": "test-replicaset",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.2",
      "storage_engine": "wiredTiger"
    },
    "region": "aaa",
    "availability_zone": "az1xahz",
    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "password": "******",
    "mode": "ReplicaSet",
    "configurations": [
      {
        "type": "replica",
        "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02"
      }
    ],
    "flavor": [
      {
        "type": "replica",
        "num": 1,
        "storage": "ULTRAHIGH",
        "size": 30,
        "spec_code": "dds.mongodb.c6.medium.4.repset"
      }
    ],
    "backup_strategy": {
      "start_time": "08:15-09:15",
      "keep_days": 8
    },
    "ssl_option": 1,
    "tags": [
      {
        "key": "dds001",
        "value": "dds001"
      }
    ]
  }

  Cree una instancia de nodo único.

  {
    "name": "test-singlenode",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.2",
      "storage_engine": "wiredTiger"
    },
    "region": "aaa",
    "availability_zone": "az1xahz",
    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
    "password": "******",
    "mode": "Single",
    "configurations": [
      {
        "type": "single",
        "configuration_id": "b8e962e66ede47609a94cba591735b49pr02"
      }
    ],
    "flavor": [
      {
        "type": "single",
        "num": 1,
        "storage": "ULTRAHIGH",
        "size": 30,
        "spec_code": "dds.mongodb.c6.medium.4.single"
      }
    ],
    "backup_strategy": {
      "start_time": "08:15-09:15",
      "keep_days": 8
    },
    "ssl_option": 1,
    "tags": [
      {
        "key": "dds001",
        "value": "dds001"
      }
    ]
  }

Respuestas

• Descripción del parámetro

  Tabla 9 Descripción del parámetro

  Nombre	Tipo	Obligatorio	Descripción
  id	String	No	Indica el ID de instancia de base de datos.
  name	String	No	Igual que el parámetro de solicitud.
  datastore	Object	No	Indica la información de la base de datos, que es la misma que el parámetro de solicitud. Para obtener más información, consulte Tabla 10.
  created	String	No	Indica la hora de creación en el siguiente formato: aaaa-mm-dd hh:mm:ss.
  status	String	No	Indica el estado de la instancia de base de datos. El valor está creating.
  region	String	No	Indica el ID de región, que es el mismo que el parámetro de solicitud.
  availability_zone	String	No	Indica el ID de zona de disponibilidad, que es el mismo que el parámetro de solicitud.
  vpc_id	String	No	Indica el ID de VPC, que es el mismo que el parámetro de solicitud.
  subnet_id	String	No	Indica el ID de red de la subred, que es el mismo que el parámetro de solicitud.
  security_group_id	String	No	Indica el ID del grupo de seguridad, que es el mismo que el parámetro de solicitud.
  port	Integer	No	Indica el puerto de la base de datos.
  disk_encryption_id	String	No	Indica el ID de la clave de encriptación del disco, que es el mismo que el parámetro de solicitud.
  mode	String	No	Indica el tipo de instancia, que es el mismo que el parámetro de solicitud.
  configurations	Array of objects	No	Información de configuración del grupo de parámetros. Para más detalles, consulte Tabla 11.
  flavor	Array of objects	No	Indica la especificación de instancia, que es la misma que el parámetro de solicitud. Para obtener más información, consulte Tabla 12.
  backup_strategy	Object	No	Indica la política de copia de respaldo avanzada, que es la misma que el parámetro de solicitud. Para obtener más información, consulte Tabla 13.
  enterprise_project_id	String	No	Indica el ID del proyecto de empresa. Si el valor es 0, el recurso pertenece al proyecto de empresa predeterminado.
  ssl_option	String	No	Indica si se debe habilitar SSL, que funciona igual que el parámetro de solicitud.
  dss_pool_id	String	No	Indica el ID del grupo de almacenamiento DSS, que es el mismo que el parámetro de solicitud.
  job_id	String	No	Indica el ID del flujo de trabajo para crear una instancia de base de datos.
  tags	Array of objects	No	Lista de etiquetas, que es la misma que el parámetro de solicitud. For details, see Tabla 14.
  order_id	String	No	ID del pedido para crear una instancia. Este parámetro solo se devuelve cuando se crea una instancia anual/mensual.
  charge_info	Object	No	Modo de facturación, que es el mismo que el parámetro de solicitud. Para más detalles, consulte Tabla 15.

  Tabla 10 Estructura de datos del campo datastore

  Nombre	Tipo	Obligatorio	Descripción
  type	String	Sí	El tipo de base de datos. El valor es DDS-Community.
  version	String	Sí	La versión de la base de datos. Las versiones 4.2, 4.0 y 3.4 son compatibles. El valor puede ser 4.2, 4.0, o 3.4. NOTA: DDS 4.2 está restringido para uso comercial. Para obtener más información, consulte los avisos de DDS. Para asegurarse de que tiene una buena experiencia con DDS, cree una instancia de DDS 4.0.
  storage_engine	String	Sí	El motor de almacenamiento. DDS soporta los motores de almacenamiento WiredTiger y RocksDB. Si la versión de la base de datos es 4.2 y el motor de almacenamiento es rocksDB, el valor es rocksDB. Si la versión de la base de datos es 4.0 o 3.4 y el motor de almacenamiento es de WiredTiger el valor es de wiredTiger.

  Tabla 11 Estructura de datos del campo Configuraciones

  Parámetro	Tipo	Obligatorio	Descripción
  type	String	Sí	Tipo de nodo. Valores válidos Para una instancia de clúster, el valor puede ser mongos, shard, o config. Para una instancia de conjunto de réplicas, el valor es replica. Para una instancia de nodo único, el valor es single. Valores enumerados: mongos shard config replica single
  configuration_id	String	Sí	ID del grupo de parámetros. Para más detalles, consulte Tabla 4.

  Tabla 12 Estructura de datos del campo de variante

  Nombre	Tipo	Obligatorio	Descripción
  type	String	Sí	El tipo de nodo. Valores válidos Para una instancia de clúster, el valor puede ser mongos, shard, o config. Para una instancia de conjunto de réplicas, el valor es replica. Para una instancia de nodo único, el valor es single.
  num	String	Sí	Número de nodos o grupos. Valores válidos Si el valor de type es mongos, num indica el número de nodos mongos en la instancia del clúster. El valor varía de 2 a 16. Si el valor de type es shard, num indica el número de grupos de shard en la instancia del clúster. El valor varía de 2 a 16. Si el valor de type es config, num indica el número de grupos de configuración en la instancia del clúster. El valor solo puede ser 1. Si el valor de type es replica, num indica el número de nodos de réplica en la instancia del conjunto de réplicas. El valor puede ser 3, 5 o 7. Si el valor de type es single, num indica el número de nodos en una instancia de nodo único. El valor solo puede ser 1.
  storage	String	No	El tipo de disco. Valor válido: ULTRAHIGH, que indica el tipo SSD. Este parámetro es válido para los nodos shard y config de una instancia de clúster y para instancias de conjuntos de réplicas. Este parámetro no es válido para los nodos mongos. Por lo tanto, no es necesario especificar el espacio de almacenamiento para los nodos mongos.
  size	String	No	El tamaño del disco. Este parámetro es obligatorio para todos los nodos excepto mongos. Este parámetro no es válido para los nodos mongos. El valor debe ser un múltiplo de 10. La unidad es GB. Para una instancia de clúster, el espacio de almacenamiento de un nodo de fragmento puede ser de 10 a 2,000 GB, y el espacio de almacenamiento de configuración es de 20 GB. Este parámetro no es válido para los nodos mongos. Por lo tanto, no es necesario especificar el espacio de almacenamiento para los nodos mongos. Para una instancia de conjunto de réplicas, el valor oscila entre 10 y 3000. Para una instancia de nodo único, el valor varía de 10 a 1000.
  spec_code	String	Sí	El código de especificación de recurso. Para obtener más información acerca de cómo obtener el valor, vea los valores de respuesta de spec_code en Consulta de especificaciones de base de datos. En una instancia de clúster, es necesario especificar varias especificaciones. Todas las especificaciones deben ser de la misma serie, es decir, de uso general (s6), mejorado (c3) o mejorado II (c6). Ejemplo: dds.mongodb.s6.large.4.mongos y dds.mongodb.s6.large.4.config tienen las mismas especificaciones. dds.mongodb.s6.large.4.mongos y dds.mongodb.c3.large.4.config no tienen las mismas especificaciones.

  Tabla 13 Estructura de datos del campo backup_strategy

  Nombre	Tipo	Obligatorio	Descripción
  start_time	String	Sí	La ventana de tiempo de copia de respaldo. Las copias de respaldo automatizadas se activarán durante la ventana de tiempo de copia de respaldo. El valor no puede estar vacío. Debe ser un valor válido en el formato "hh:mm-HH:MM". La hora actual está en el formato UTC. El valor HH debe ser 1 mayor que el valor hh. Los valores de mm y MM deben ser los mismos y deben establecerse en 00. Si este parámetro no se transfiere, la ventana de tiempo de copia de respaldo predeterminada se establece en 00:00-01:00. Valor de ejemplo: 23:00-00:00
  keep_days	String	No	El número de días para conservar los archivos de copia de respaldo generados. El intervalo de valores es de 0 a 732. Si este parámetro se establece en 0, la política de copia de respaldo automatizada no se establece. Si este parámetro no se transfiere, la política de copia de respaldo automatizada está habilitada de forma predeterminada. Los archivos de copia de seguridad se almacenan durante siete días de forma predeterminada.

  Tabla 14 Estructura de datos del campo de etiquetas

  Nombre	Tipo	Obligatorio	Descripción
  key	String	Sí	Clave de etiqueta. El valor puede contener un máximo de 36 caracteres unicode. La clave no se puede dejar en blanco ni una cadena vacía. El conjunto de caracteres es el siguiente: A-Z, a-z, 0-9, guiones (-) y caracteres Unicode (\u4E00-\u9FFF).
  value	String	Sí	Valor de la etiqueta. Contiene un máximo de 43 caracteres Unicode. El valor puede ser una cadena vacía. El conjunto de caracteres es el siguiente: A-Z, a-z, 0-9, guiones (-) y caracteres Unicode (\u4E00-\u9FFF).

  Tabla 15 Estructura de datos del campo ChargeInfo

  Parámetro	Tipo	Obligatorio	Descripción
  charge_mode	String	Sí	Modo de facturación. Rango de valores: prePaid: indica el modo de facturación anual/mensual. postPaid: indica el modo de facturación de pago por uso.
  period_type	String	No	Periodo de suscripción. Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Rango de valores: month: El servicio se suscribe por mes. year: El servicio se suscribe por año.
  period_num	Integer	No	Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Rango de valores: Si period_type se establece en month, el valor del parámetro oscila entre 1 y 9. Si period_type se establece en year, el valor del parámetro varía de 1 a 3.
  is_auto_renew	Boolean	No	Si la renovación automática está habilitada para instancias anuales/mensuales. El período de renovación es el mismo que el período original y el pedido se pagará automáticamente durante la renovación de la suscripción. Rango de valores: true: indica que la suscripción se renueva automáticamente. false: indica que la suscripción no se renueva automáticamente. El valor predeterminado es false.
  is_auto_pay	Boolean	No	Forma de pago. Al crear una instancia de base de datos anual/mensual, puede especificar si debe pagar automáticamente con su cuenta. Este parámetro no afecta al método de pago de la renovación automática. Rango de valores: true: indica que la tarifa se paga automáticamente desde la cuenta. false: indica que la tarifa se paga manualmente desde la cuenta. Este método de pago se utiliza por defecto.

Los valores de region y available_zone se usan como ejemplos.

• Ejemplo de respuesta

  Instancia de clúster:

  {
    "id": "39b6a1a278844ac48119d86512e0000bin02",
    "name": "test-cluster-01",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.4",
      "storage_engine": "wiredTiger"
    },
    "created": "2019-01-16 09:34:36",
    "status": "creating",
    "region": "aaa",
    "availability_zone": "az1xahz",
    "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
    "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
    "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
    "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
    "mode": "Sharding",
    "configurations": [
      {
        "type": "mongos",
        "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
      },
      {
        "type": "shard",
        "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
      },
      {
        "type": "config",
        "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
      }
    ],
    "flavor": [
      {
        "type": "mongos",
        "num": 2,
        "spec_code": "dds.mongodb.c6.medium.4.mongos"
      },
      {
        "type": "shard",
        "num": 2,
        "spec_code": "dds.mongodb.c6.medium.4.shard",
        "size": 20
      },
      {
        "type": "config",
        "num": 1,
        "spec_code": "dds.mongodb.c6.large.2.config",
        "size": 20
      }
    ],
    "backup_strategy": {
      "start_time": "08:15-09:15",
      "keep_days": "8"
    },
    "enterprise_project_id": "",
    "ssl_option": "1",
    "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
    "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
    "tags": [
      {
        "key": "dds001",
        "value": "dds001"
      }
    ]
  }

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.