Dados personalizados
O Equinix Metal™ oferece um serviço de dados personalizado, para que você possa definir e consumir dados sobre seus servidores e infraestrutura por meio dos metadados do servidor e da API do Equinix Metal .
Uma maneira de pensar em dados personalizados é como um recurso de tag muito mais expressivo. Dados personalizados permitem strings, arrays, mapas, mapas de arrays de números, booleanos em formato JSON, etc. Os campos e propriedades do objeto são totalmente definidos pelo usuário e têm como objetivo oferecer opções adicionais de automação. Os objetos JSON usados nesta página são apenas exemplos simples.
Provisionamento com dados personalizados
- Console
- API
Para adicionar dados personalizados ao seu servidor durante o provisionamento, expanda a seção Configurações Opcionais. Selecione Dados Personalizados. Insira seus dados em formato JSON no campo.

Ao provisionamento seu servidor na API, defina seu objeto de dados personalizado no corpo da solicitar POST para o endpoint /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
}
}
}'
Acessando dados personalizados
- Console
- Server Metadata
- API
Após o provisionamento do servidor, você poderá acesso os Dados Personalizados na aba Configurações do servidor.

Deslize a tela até a seção Dados Personalizados.

Depois que seus dados personalizados forem definidos em seu servidor, você poderá acesso -los localmente no servidor a partir do endpoint de metadados do servidor.
curl https://metadata.platformequinix.com/metadata | jq '.customdata'
Você pode acesso os dados personalizados de fora do servidor através do endpoint da API devices/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/devices/{id}/customdata
Os dados personalizados ficam acessíveis enquanto o servidor estiver provisionado no seu projeto.
Adicionar ou modificar dados personalizados
- Console
- API
Para atualizar os dados personalizados do seu servidor, abra a aba Configurações do servidor.

Deslize a tela até a seção Dados Personalizados, insira seus novos dados em formato JSON no campo e clique em Salvar.

Para atualizar os dados personalizados do seu servidor, envie um PUT para o endpoint /devices/{id}, definindo o objeto de dados personalizados no corpo da solicitar.
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"
}
}
}'
Dados personalizados para outros recursos
Além dos servidores, outros recursos do Equinix Metal suporte dados personalizados por meio da API. Embora não estejam disponíveis nos metadados, esses endpoints podem ser aproveitados para armazenamento remoto de estado específico do recurso que oferece a propriedade "customdata".
Usuários
Você pode adicionar dados personalizados a qualquer usuário já criado com o endpoint /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
}
}
}'
E então você pode acesso -lo a partir do endpoint /users/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/users/{id}/customdata
Projetos
Você pode criar um projeto com dados personalizados incluindo-os no corpo do seu POST para o endpoint /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>"
}'
Você pode atualizar os dados personalizados de um Projeto usando o campo "customdata" no corpo de uma solicitar PUT para o endpoint /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
}
}
}'
E finalmente, você pode recuperar os dados personalizados de um projeto a partir do endpoint /projects/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/projects/{id}/customdata
Organizações
Você pode adicionar dados personalizados a qualquer Organização usando o campo "customdata" no corpo de uma solicitar PUT para o endpoint /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"
}
}'
Você pode recuperar os dados personalizados de uma organização a partir do endpoint /organizations/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/organizations/{id}/customdata
Endereços IP
Você pode adicionar dados personalizados a um endereço IP quando ele for atribuído a um servidor, incluindo o campo "customdata" no corpo da sua solicitar POST para o endpoint /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"
}
}'
Você pode atualizar os dados personalizados de um endereço IP usando o campo "customdata" no corpo de uma solicitar PATCH para o endpoint /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"
}
}'
Você pode recuperar os dados personalizados de um endereço IP do endpoint /ips/{id}/customdata.
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/ips/{id}/customdata