Datos personalizados
Equinix Metal™ ofrece un servicio de datos personalizado, para que pueda definir y consumir datos sobre sus servidores e infraestructura a través de los metadatos del servidor y la API de Equinix Metal.
Una forma de ver los datos personalizados es como una función de etiqueta mucho más expresiva. Los datos personalizados permiten cadenas con formato JSON, matrices, mapas, mapas de matrices de números, booleanos, etcétera. Los campos y las propiedades de los objetos están completamente definidos por el usuario y su objetivo es ofrecer opciones adicionales para la automatización. Los objetos JSON utilizados en esta página son simples ejemplos.
Aprovisionamiento con datos personalizados
- Console
- API
Para añadir Datos personalizados a su servidor en el momento del aprovisionamiento, amplíe la sección Configuración opcional. Seleccione Datos personalizados. Introduzca sus datos con formato JSON en el campo.

Cuando aprovisione su servidor en la API, defina su objeto de datos personalizado en el cuerpo de la solicitud POST al punto final /projects/{id}/devices.
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/devices" \
-d '{
"metro": "<metro_code>",
"plan": "<server_type>",
"operating_system": "<os_code>",
"customdata": {
"data": {
"text": "testing device",
"frozen": false,
"oneOf": 3
}
}
}'
Acceso a datos personalizados
- Console
- Server Metadata
- API
Una vez aprovisionado su servidor, puede acceder a sus Datos personalizados desde la pestaña Configuración del servidor.

Desplácese hasta la sección Datos personalizados.

Una vez que sus datos personalizados estén definidos en su servidor, podrá acceder a ellos localmente en el servidor desde el [punto final de metadatos] del servidor (metadata.md).
curl https://metadata.platformequinix.com/metadata | jq '.customdata'
Puede acceder a los datos personalizados desde fuera del servidor desde el punto final API devices/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/devices/{id}/customdata
Los datos personalizados son accesibles mientras el servidor esté aprovisionado en su proyecto.
Añadir o modificar datos personalizados
- Console
- API
Para actualizar los datos personalizados de su servidor, abra la pestaña Configuración del servidor.

Desplácese hasta la sección Datos personalizados e introduzca sus nuevos datos con formato JSON en el campo y haga clic en Guardar.

Para actualizar los datos personalizados de su servidor, envíe un PUT al punto final /devices/{id}, definiendo el objeto de datos personalizados en el cuerpo de la solicitud.
curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: $API_TOKEN" \
"https://api.equinix.com/metal/v1/devices/{id}" \
-d '{
"customdata": {
"data": {
"text": "Click Here"
}
}
}'
Datos personalizados para otros recursos
Además de servidores, otros recursos Equinix Metal admiten datos personalizados a través de la API. Aunque no están disponibles en los metadatos, estos puntos finales pueden aprovecharse para el almacenamiento de estado remoto particular del recurso que ofrece la propiedad "customdata".
Usuarios
Puede añadir datos personalizados a cualquier usuario ya creado con el punto final /users/{id}.
curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/users/{id}" \
-d '{
"customdata": {
"data": {
"text": "bot-user-1",
"auto-rotate": true
}
}
}'
Y entonces podrá acceder a él desde el punto final /users/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/users/{id}/customdata
Proyectos
Puede crear un proyecto con datos personalizados incluyéndolos en el cuerpo de su POST al punto final /projects.
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/" \
-d '{
"customdata": {
"data": {
"text": "dev-env-05",
"do-not-disturb": false
}
},
"name": "string",
"organization_id": "<uuid>",
"payment_method_id": "<uuid>"
}'
Puede actualizar los datos personalizados de un proyecto utilizando el campo "customdata" en el cuerpo de una solicitud PUT al punto final /projects/{id}.
curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}" \
-d '{
"customdata": {
"data": {
"text": "dev-env-05",
"do-not-disturb": true
}
}
}'
Y por último, puede recuperar los datos personalizados de un proyecto desde el punto final /projects/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/projects/{id}/customdata
Organizaciones
Puede añadir datos personalizados a cualquier Organización utilizando el campo "customdata" en el cuerpo de una solicitud PUT al punto final /organizations/{id}.
curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/organizations/{id}" \
-d '{
"customdata": {
"data": {
"text": "cluster-03",
"do-not-disturb": true
},
"owners": "internal"
}
}'
Puede recuperar los datos personalizados de una Organización desde el punto final /organizations/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/organizations/{id}/customdata
Direcciones IP
Puede añadir datos personalizados a una dirección IP cuando se asigna a un servidor incluyendo el campo "customdata" en el cuerpo de su solicitud POST al punto final /devices/{id}/ips.
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/devices/{id}/ips" \
-d '{
"address": "198.51.100.3/31",
"customdata": {
"data": {
"text": "connect-me",
"can_float": false
},
"group": "for_vms"
}
}'
Puede actualizar los datos personalizados de una dirección IP utilizando el campo "customdata" en el cuerpo de una solicitud PATCH al punto final /ips/{id}.
curl -X PATCH \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/ips/{id}" \
-d '{
"address": "198.51.100.3/31",
"customdata": {
"data": {
"text": "connect-me",
"can_float": true
},
"group": "static"
}
}'
Puede recuperar los datos personalizados de una dirección IP desde el punto final /ips/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/ips/{id}/customdata