Devuelve la lista de regiones disponibles para el proveedor de nube especificado en el nivel especificado.
- Proyecto de solo lectura
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})$.
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. -
Indicador que señala si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor por defecto es
true. -
Número de elementos que la respuesta retorna por página.
El valor mínimo es
1, el valor máximo es500. El valor por defecto es100. -
Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
El valor mínimo es
1. El valor por defecto es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.pretty-print -
Proveedores de la nube cuyas regiones se deben recuperar. Cuando se especifican varios proveedores, la respuesta solo puede incluir niveles y regiones que sean compatibles con clústeres multi-nube.
-
Nivel de clúster para el que recuperar las regiones.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/provider/regions' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"instanceSizes": [
{
"availableRegions": [
{
"default": true,
"name": "string"
}
],
"name": "string"
}
],
"provider": "AWS"
}
],
"totalCount": 42
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}