For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/pt/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/pt/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/pt/guides/web-cloud/web-hosting/api-webhosting.md.

Como criar e gerir uma aplicação web utilizando a API pública da OVHcloud

Ver como Markdown

Saiba como utilizar a API pública da OVHcloud para criar uma aplicação web: associar domínios, gerir bases de dados e configurar certificados SSL

Objetivo

Este guia explica-lhe como utilizar a API pública da OVHcloud para criar e gerir uma aplicação web no seu alojamento. Vai aprender a efetuar as operações essenciais: associar domínios, gerir bases de dados e configurar certificados SSL.

Requisitos

Warning

A utilização das API da OVHcloud exige conhecimentos avançados nesta área. Em caso de dificuldade, contacte os parceiros OVHcloud.

Instruções

Obter as informações do serviço

O primeiro passo consiste em obter o serviceName, um identificador único do seu serviço de alojamento web. Vai precisar dele para a maioria das chamadas à API seguintes.

GET/hosting/web

Este comando devolve uma lista dos seus serviços de alojamento web. Cada entrada da lista é um serviceName.

Exemplo de resposta:

[
  "example.cluster01.hosting.ovh.net",
  "example2.cluster02.hosting.ovh.net"
]

Associar um domínio

Associe um domínio ao seu serviço de alojamento web:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
bypassDNSConfigurationnãoSe estiver ativado, a zona DNS não será atualizada
cdnnãoIndica se o domínio está associado ao CDN do alojamento. Valores permitidos: active┃none
domainnãoDomínio a associar
firewallnãoIndica se a firewall está ativa para este domínio. Valores permitidos: active┃none
ipLocationnãoDefine a localização IP associada ao domínio. Valores permitidos: BE┃CA┃CZ┃DE┃ES┃FI┃FR┃IE┃IT┃LT┃NL┃PL┃PT┃UK
ownLognãoDomínio para separar os logs
pathnãoCaminho onde serão armazenados os ficheiros web
runtimeIdnãoIdentificador da configuração runtime utilizada neste domínio
sslnãoOpção para ativar o SSL no domínio

Exemplo de resposta:

{
 "doneDate": "2024-08-22T08:13:50.740Z",
 "function": "abuse/close",
 "id": 0,
 "lastUpdate": "2024-08-22T08:13:50.740Z",
 "objectId": "string",
 "objectType": "Abuse",
 "startDate": "2024-08-22T08:13:50.740Z",
 "status": "cancelled"
}

Gerar certificados SSL

Configure e faça a gestão dos certificados SSL para proteger o seu site:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
certificatenãoCertificado SSL a instalar
chainnãoCadeia de certificados utilizada para validar o certificado SSL
keynãoChave privada associada ao certificado SSL

Exemplo de resposta:

{
 "isReportable": false,
 "provider": "COMODO",
 "regenerable": false,
 "status": "created",
 "taskId": 0,
 "type": "CUSTOM"
}

Gerir as bases de dados

As API de alojamento web da OVHcloud permitem-lhe igualmente gerir as suas bases de dados.

Criar uma base de dados

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
capacitysimCapacidades da base de dados. Valores: extraSqlPersonal┃local┃privateDatabase┃sqlLocal┃sqlPersonal┃sqlPro
usersimNome de utilizador da base de dados. Deve estar em minúsculas e começar pelo identificador do seu alojamento web
passwordnãoPalavra-passe da base de dados
quotanãoEspaço atribuído. Valores: 25┃100┃200┃256┃400┃512┃800┃1024
typesimTipo de base de dados. Valores: mariadb┃mysql┃postgresql┃redis
versionnãoVersão da base de dados

Exemplo de resposta:

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listar as bases de dados existentes

Liste todas as bases de dados associadas ao seu serviço de alojamento web:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
modesimValores permitidos: besteffort ┃ classic ┃ module

Exemplo de resposta:

[
 "example.mysql.db",
 "example2.mysql.db"
]

Gerir os módulos

Obter uma lista de módulos

Obtenha uma lista dos módulos disponíveis que pode instalar no seu alojamento web:

ParâmetroObrigatórioDescrição
activenãoFiltra os módulos ativados ou desativados
branchnãoFiltra os módulos consoante a versão. Valores permitidos: old ┃ stable ┃ testing
latestnãoFiltro que permite exibir os módulos correspondentes à versão mais recente

Exemplo de resposta:

[
 195,
 184,
 38,
 176
]

Obter as informações de um módulo

Obtenha os detalhes de um módulo específico instalado no seu alojamento web:

ParâmetroObrigatórioDescrição
idsimIdentificador do módulo

Exemplo de resposta:

{
 "keywords": [
   "gallery"
 ],
 "adminNameType": "string",
 "author": "OVH",
 "branch": "old",
 "id": 195,
 "size": {
   "value": 0,
   "unit": "B"
 },
 "name": "myname",
 "upgradeFrom": [],
 "language": [
   "en",
   "fr",
   "de",
   "es",
   "pl"
 ],
 "version": "1.4.2.2",
 "active": false,
 "languageRequirement": {
   "value": "php",
   "unit": "supported versions: ''\nnon supported versions: '8+'"
 },
 "latest": true
}

Instalar um novo módulo

Instale um novo módulo no seu serviço de alojamento web:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
moduleIdsimIdentificador do módulo a instalar
adminNamenãoNome do administrador
adminpasswordnãoPalavra-passe da conta de administrador
domainnãoNome de domínio onde o módulo será implementado
languagenãoIdioma da instalação do módulo
pathnãoCaminho no servidor onde o módulo será instalado
dependencies -> namenãoNome do serviço dependente
dependencies -> passwordnãoPalavra-passe do serviço dependente
dependencies -> portnãoPorta de ligação do serviço
dependencies -> prefixnãoPrefixo utilizado na configuração do serviço
dependencies -> servernãoEndereço do servidor do serviço dependente
dependencies -> typenãoTipo de serviço (ex.: MySQL)
dependencies -> usernãoNome de utilizador do serviço dependente

Exemplo de resposta:

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Gerir os utilizadores FTP

Faça a gestão dos utilizadores FTP/SSH do seu alojamento web para facilitar os acessos e as configurações.

Criar um novo utilizador FTP/SSH

Crie um novo utilizador FTP ou SSH para aceder ao seu alojamento web:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
homesimDiretório principal
loginsimNome de utilizador
passwordsimPalavra-passe
sshStatenãoDetermina o estado do acesso SSH do utilizador. Valores permitidos: active ┃none ┃sftponly

Exemplo de resposta:

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listar os utilizadores FTP/SSH

Liste todos os utilizadores FTP/SSH existentes no seu serviço de alojamento:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
homenãoFiltra os utilizadores consoante o respetivo diretório principal
loginnãoFiltra os utilizadores consoante o respetivo nome de utilizador

Exemplo de resposta:

[
 "user1",
 "user2",
 "user3",
 "user4"
]

Restaurar uma base de dados

Crie, liste e restaure backups de bases de dados do seu site.

Criar um backup de uma base de dados

Crie um backup da sua base de dados para a restaurar em caso de necessidade:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
namesimNome da base de dados
datesimTipo de backup. Valores permitidos: daily.1┃now┃weekly.1
sendEmailnãoSe este parâmetro estiver ativado, é enviado um e-mail quando o backup fica disponível

Exemplo de resposta:

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listar os backups de bases de dados disponíveis

Liste todos os backups disponíveis para as suas bases de dados:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
namesimNome da base de dados
creationDate.fromnãoFiltra os backups criados a partir desta data
creationDate.tonãoFiltra os backups criados até esta data
deletionDate.fromnãoFiltra os backups eliminados a partir desta data
deletionDate.tonãoFiltra os backups eliminados até esta data
typenãoFiltra os backups consoante o tipo. Valores permitidos: daily.1┃now┃weekly.1

Exemplo de resposta:

[
 1,
 12
]

Restaurar um backup específico de uma base de dados

Restaure um backup específico da sua base de dados em caso de problema:

ParâmetroObrigatórioDescrição
serviceNamesimNome do serviço
namesimNome da base de dados
idsimIdentificador do backup

Exemplo de resposta:

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Conclusão

Este guia apresentou-lhe os principais pedidos à API para gerir o seu alojamento web OVHcloud, como a associação de domínios e a gestão de certificados SSL e de bases de dados.

Existem, no entanto, muitas outras chamadas à API disponíveis, que pode explorar consoante as suas necessidades. Para mais opções e funcionalidades, consulte a secção "" da API da OVHcloud.

Quer saber mais?

Order a domain name via API

Fale com a nossa comunidade de utilizadores.

Esta página foi útil?