O artigo solicitado não está disponível. Ou ele não se aplica a esta versão do produto ou as informações relevantes estão organizadas de forma diferente nesta versão dos documentos. Você pode pesquisar, navegar ou voltar para a outra versão.

O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Detalhes da implementação da API REST das ferramentas ONTAP

07/24/2026 Colaboradores

PDFs

Embora o REST estabeleça um conjunto comum de tecnologias e boas práticas, a implementação exata de cada API pode variar de acordo com as escolhas de design. Você deve se familiarizar com como a API REST do ONTAP tools for VMware vSphere 10 foi projetada antes de usá-la.

A API REST inclui diversas categorias de recursos, como vCenters e agregados. Consulte a documentação "Referência API" para obter mais informações.

Como acessar a API REST

Você pode acessar as ONTAP tools for VMware vSphere 10 API REST através do endereço IP das ONTAP tools junto com a porta. Há várias partes na URL completa, incluindo:

Endereço IP e porta das ferramentas ONTAP
Versão API
Categoria de recurso
Recurso específico

Você deve configurar o endereço IP durante a configuração inicial, enquanto a porta permanece fixa em 8443. A primeira parte da URL é consistente para cada instância do ONTAP tools for VMware vSphere 10; apenas a categoria do recurso e o recurso específico mudam entre os endpoints.

Os valores de endereço IP e porta nos exemplos abaixo são apenas para fins ilustrativos. Você precisa alterar esses valores para o seu ambiente.

Exemplo de acesso a serviços de autenticação

https://10.61.25.34:8443/virtualization/api/v1/auth/login

Esta URL pode ser usada para solicitar um token de acesso usando o método POST.

Exemplo para listar os servidores vCenter

https://10.61.25.34:8443/virtualization/api/v1/vcenters

Este URL pode ser usado para solicitar uma lista das instâncias de servidor vCenter definidas usando o método GET.

Detalhes HTTP

As ONTAP tools for VMware vSphere 10 API REST usam HTTP e parâmetros relacionados para agir sobre as instâncias e coleções de recursos. Os detalhes da implementação HTTP são apresentados abaixo.

Métodos HTTP

Os métodos ou verbos HTTP suportados pela API REST são apresentados na tabela abaixo.

Método	CRUD	Descrição
GET	Ler	Recupera as propriedades de um objeto para uma instância de recurso ou coleção. Isso é considerado uma operação de listagem quando usado com uma coleção.
POST	Criar	Cria uma nova instância de recurso com base nos parâmetros de entrada.
PUT	Atualizar	Atualiza toda a instância do recurso com o corpo da solicitação JSON fornecido. Os valores-chave que não podem ser modificados pelo usuário são preservados.
PATCH	Atualizar	Solicita que um conjunto de alterações selecionadas na solicitação seja aplicado à instância do recurso.
EXCLUIR	Excluir	Exclui uma instância de recurso existente.

Método

CRUD

Descrição

GET

Ler

Recupera as propriedades de um objeto para uma instância de recurso ou coleção. Isso é considerado uma operação de listagem quando usado com uma coleção.

POST

Criar

Cria uma nova instância de recurso com base nos parâmetros de entrada.

PUT

Atualizar

Atualiza toda a instância do recurso com o corpo da solicitação JSON fornecido. Os valores-chave que não podem ser modificados pelo usuário são preservados.

PATCH

Atualizar

Solicita que um conjunto de alterações selecionadas na solicitação seja aplicado à instância do recurso.

EXCLUIR

Excluir

Exclui uma instância de recurso existente.

Cabeçalhos de solicitação e resposta

A tabela a seguir resume os cabeçalhos HTTP mais importantes usados com a API REST.

Cabeçalho Tipo Notas de uso

Cabeçalho	Tipo	Notas de uso
Aceitar	Solicitação	Este é o tipo de conteúdo que o aplicativo cliente pode aceitar. Os valores válidos incluem '/` ou `application/json`.
x-auth	Solicitação	Contém um token de acesso que identifica o usuário que emitiu a solicitação por meio do aplicativo cliente.
Content-Type	Resposta	Retornado pelo servidor com base no `Accept`cabeçalho da solicitação.

Aceitar

Solicitação

Este é o tipo de conteúdo que o aplicativo cliente pode aceitar. Os valores válidos incluem '*/*` ou application/json.

x-auth

Solicitação

Contém um token de acesso que identifica o usuário que emitiu a solicitação por meio do aplicativo cliente.

Content-Type

Resposta

Retornado pelo servidor com base no `Accept`cabeçalho da solicitação.

Códigos de status HTTP

Os códigos de status HTTP usados pela API REST são descritos abaixo.

Código	Significado	Descrição
200	OK	Indica sucesso para chamadas que não criam uma nova instância de recurso.
201	Criado	Um objeto foi criado com sucesso com um identificador exclusivo para a instância do recurso.
202	Aceito	A solicitação foi aceita e uma tarefa em segundo plano foi criada para executá-la.
204	Sem conteúdo	A solicitação foi bem-sucedida, embora nenhum conteúdo tenha sido retornado.
400	Pedido ruim	A entrada solicitada não foi reconhecida ou é inadequada.
401	Não autorizado	O usuário não está autorizado e deve se autenticar.
403	Proibido	O acesso foi negado devido a um erro de autorização.
404	Não encontrado	O recurso mencionado na solicitação não existe.
409	Conflito	A tentativa de criar um objeto falhou porque o objeto já existe.
500	Erro interno	Ocorreu um erro interno geral no servidor.

Código

Significado

Descrição

200

Indica sucesso para chamadas que não criam uma nova instância de recurso.

201

Criado

Um objeto foi criado com sucesso com um identificador exclusivo para a instância do recurso.

202

Aceito

A solicitação foi aceita e uma tarefa em segundo plano foi criada para executá-la.

204

Sem conteúdo

A solicitação foi bem-sucedida, embora nenhum conteúdo tenha sido retornado.

400

Pedido ruim

A entrada solicitada não foi reconhecida ou é inadequada.

401

Não autorizado

O usuário não está autorizado e deve se autenticar.

403

Proibido

O acesso foi negado devido a um erro de autorização.

404

Não encontrado

O recurso mencionado na solicitação não existe.

409

Conflito

A tentativa de criar um objeto falhou porque o objeto já existe.

500

Erro interno

Ocorreu um erro interno geral no servidor.

Autenticação

A autenticação de um cliente na API REST é realizada por meio de um token de acesso. As características relevantes do token e do processo de autenticação incluem:

O cliente deve solicitar um token usando as credenciais de administrador do ONTAP tools Manager (nome de usuário e senha).
Os tokens são formatados como um JSON Web Token (JWT).
Cada token expira após 60 minutos.
As solicitações de API de um cliente devem incluir o token no x-auth cabeçalho da solicitação.

Consulte "Sua primeira chamada à API REST" para um exemplo de como solicitar e usar um token de acesso.

Requisições síncronas e assíncronas

A maioria das chamadas à API REST é concluída rapidamente e, portanto, executada de forma síncrona. Ou seja, elas retornam um código de status (como 200) após a conclusão da solicitação. As solicitações que levam mais tempo para serem concluídas são executadas de forma assíncrona, utilizando uma tarefa em segundo plano.

Após emitir uma chamada de API que é executada de forma assíncrona, o servidor retorna um código de status HTTP 202. Isso indica que a solicitação foi aceita, mas ainda não foi concluída. Você pode consultar a tarefa em segundo plano para determinar seu status, incluindo sucesso ou falha.

O processamento assíncrono é usado para diversos tipos de operações de longa duração, incluindo operações de datastore e vVol. Consulte a categoria job manager da API REST na página do Swagger para mais informações.