Atualização dos metadados do BMS
Função
Essa API é usada para atualizar os metadados do BMS.
- Se os metadados não contiverem o campo de destino, o campo será adicionado automaticamente ao campo.
- Se os metadados contiverem o campo de destino, o valor do campo será atualizado automaticamente.
- Se o campo nos metadados não for solicitado, o valor do campo permanecerá inalterado.
Restrições
O BMS deve estar no estado ativo, parado, pausado ou suspenso, que é especificado pelo atributo OS-EXT-STS:vm_state.
URI
POST /v1/{project_id}/baremetalservers/{server_id}/metadata
Parâmetro |
Obrigatório |
Descrição |
---|---|---|
project_id |
Sim |
Especifica o ID do projeto. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto. |
server_id |
Sim |
Especifica o ID do BMS. Você pode obter o ID do BMS no console do BMS ou usando a API do Consulta de BMSs (API OpenStack nativo). |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
metadata |
Sim |
Object |
Especifica o par chave-valor de metadados definido pelo usuário. Se você não especificar nenhum par chave-valor, os metadados não serão atualizados. key: ele contém no máximo 255 caracteres Unicode, que podem ser letras, dígitos, hifens (-), sublinhados (_), dois-pontos (:) e pontos (.). O key não pode ser deixada em branco. value: ele contém um máximo de 255 caracteres Unicode. |
- Exemplo de solicitação
1
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata
1 2 3 4 5
{ "metadata": { "key": "value" } }
Resposta
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
metadata |
Sim |
Object |
Especifica o par chave-valor de metadados definido pelo usuário. Se você não especificar nenhum par chave-valor, os metadados não serão atualizados. key: ele contém no máximo 255 caracteres Unicode, que podem ser letras, dígitos, hifens (-), sublinhados (_), dois-pontos (:) e pontos (.). O key não pode ser deixada em branco. value: ele contém um máximo de 255 caracteres Unicode. |
- Exemplo de resposta
1 2 3 4 5
{ "metadata":{ "key": "value" } }
Valores retornados
Valores retornados |
Descrição |
---|---|
200 |
A solicitação foi processada com sucesso. |
Para obter detalhes sobre outros valores retornados, consulte Códigos de status.
Códigos de erro
Consulte Códigos de erro.