Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Bare Metal Server/ Referência de API/ APIs do BMS/ Gerenciamento de status do BMS/ Parar os BMSs
Atualizado em 2023-03-20 GMT+08:00
Ver PDF
Compartilhar

Parar os BMSs

Função

Esta API é usada para parar BMSs de IDs especificados. Você pode parar no máximo 1000 BMSs por vez.

Esta API é uma API assíncrona. Chamar a API com sucesso indica que a tarefa foi entregue com sucesso. Para verificar se a tarefa foi bem-sucedida, use a API do Consulta do status de tarefas.

URI

POST /v1/{project_id}/baremetalservers/action

A Tabela 1 lista os parâmetros.
Tabela 1 Descrição do parâmetro

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.

Solicitação

  • Parâmetros de solicitação

    Na solicitação, os parâmetros para parar os BMSs devem ser enviados através do campo os-stop. Para obter detalhes, consulte a solicitação de exemplo.

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    os-stop

    Sim

    Object

    Especifica a operação para parar BMSs. Para mais detalhes, consulte Tabela 2.
    Tabela 2 Descrição da estrutura de dados do campo os-stop

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    servers

    Sim

    Array of objects

    Especifica IDs do BMS. Para mais detalhes, consulte Tabela 3.

    type

    Não

    String

    Especifica o tipo de parada do BMS.

    • SOFT: parada flexível (inválido)
    • HARD: parada (padrão)
    Tabela 3 Descrição da estrutura de dados do campo servers

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    id

    Sim

    String

    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).
  • Exemplo de solicitação 
    1
    		 
    POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    		 
    {
    "os-stop": {
        "type": "HARD",
        "servers": [
            {
                "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
            },
            {
                "id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
            }
        ]
    }
}

Resposta

  • Resposta normal
Tabela 4 Resposta normal

Parâmetro

Tipo

Descrição

job_id

String

Especifica o ID de tarefa retornada após a emissão de um comando de tarefa. O ID da tarefa pode ser usado para consultar o status de execução da tarefa.

Para obter detalhes sobre como consultar o status de execução da tarefa com base em job_id, consulte Consulta do status de tarefas.
  • Resposta anormal
Tabela 5 Resposta anormal

Parâmetro

Tipo

Descrição

error

Estrutura de dados do dicionário

Especifica o erro retornado quando um envio de tarefa encontra uma exceção. Para mais detalhes, consulte Tabela 6.
Tabela 6 Estrutura de dados de error

Parâmetro

Tipo

Descrição

message

String

Especifica a mensagem de erro.

code

String

Especifica o código de erro.

Exemplo de resposta

  • Resposta normal 
    1
2
3
    		 
    { 
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
}

Valores retornados

Valores normais

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.

Tópico principal: Gerenciamento de status do BMS