Crea un índice en el clúster identificado por su nombre de forma continua. Crear el índice de esta manera permite la creación de índices en un solo miembro del conjunto de réplicas a la vez, comenzando por los miembros secundarios. Crear índices de esta manera requiere al menos una elección en el set de réplicas. Para utilizar este recurso, la Cuenta de servicio o la clave de API solicitante debe tener el rol de Administrador de acceso a los datos del Proyecto.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica el clúster en el que MongoDB nube crea un índice.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Índice rotatorio a crear en el clúster especificado.
-
Uno o varios ajustes que especifican reglas específicas del lenguaje para comparar cadenas dentro de este índice.
Opciones de intercalación -
Etiqueta legible por humanos de la colección para la que MongoDB Cloud crea un índice.
-
Etiqueta legible por humanos de la base de datos que contiene la colección sobre la que MongoDB nube crea un índice.
-
Lista que contiene uno o más objetos que describen los parámetros que desea indexar.
-
Una o más configuraciones que determinan cómo la MongoDB nube crea este índice de MongoDB.
Opciones del índice
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/index' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"db":"sample_airbnb","keys":[{"property_type":"1"}],"options":{"name":"PartialIndexTest","partialFilterExpression":{"limit":{"$gt":900}}},"collation":{"locale":"af","strength":3,"alternate":"non-ignorable","backwards":false,"caseFirst":"lower","caseLevel":false,"maxVariable":"punct","normalization":false,"numericOrdering":false},"collection":"accounts"}'{
"db": "sample_airbnb",
"keys": [
{
"property_type": "1"
}
],
"options": {
"name": "PartialIndexTest",
"partialFilterExpression": {
"limit": {
"$gt": 900
}
}
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"db": "sample_airbnb",
"keys": [
{
"property_type": "1"
}
],
"options": {
"name": "PartialIndexTest",
"partialFilterExpression": {
"limit": {
"$gt": 900
}
}
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"db": "sample_airbnb",
"keys": [
{
"test_field": "1"
}
],
"options": {
"name": "SparseIndexTest",
"sparse": true
},
"collation": {
"locale": "af",
"strength": 3,
"alternate": "non-ignorable",
"backwards": false,
"caseFirst": "lower",
"caseLevel": false,
"maxVariable": "punct",
"normalization": false,
"numericOrdering": false
},
"collection": "accounts"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}