Proxy

Regras de domínio das functions.

Classe Proxy: 7 métodos (0 no @owbase/web, 7 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

listRules

Listar regras

SDK: só @owbase/node

Obtém a lista de todas as regras de proxy. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
queries	string[]	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
total	boolean	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo rules.read.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.listRules({
    queries: [], // opcional
    total: false, // opcional
});

createAPIRule

Criar regra de API

SDK: só @owbase/node

Cria uma regra de proxy para servir a API do Owbase num domínio próprio.

O ID da regra é gerado automaticamente como o hash MD5 do domínio da regra, por desempenho.

Parâmetro	Tipo	Obrigatório	Descrição
domain	string	sim	Nome do domínio.

Acesso: chave de API com o escopo rules.write.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.createAPIRule({
    domain: 'example.com',
});

createFunctionRule

Criar regra de function

SDK: só @owbase/node

Cria uma regra de proxy para executar uma function do Owbase num domínio próprio.

O ID da regra é gerado automaticamente como o hash MD5 do domínio da regra, por desempenho.

Parâmetro	Tipo	Obrigatório	Descrição
domain	string	sim	Nome do domínio.
functionId	string	sim	ID da function a executar.
branch	string	não	Nome da branch do VCS cujas mudanças viram deploy automaticamente

Acesso: chave de API com o escopo rules.write.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.createFunctionRule({
    domain: 'example.com',
    functionId: '<FUNCTION_ID>',
    branch: '<BRANCH>', // opcional
});

createRedirectRule

Criar regra de redirecionamento

SDK: só @owbase/node

Cria uma regra de proxy para redirecionar de um domínio próprio para outro domínio.

O ID da regra é gerado automaticamente como o hash MD5 do domínio da regra, por desempenho.

Parâmetro	Tipo	Obrigatório	Descrição
domain	string	sim	Nome do domínio.
url	string	sim	URL de destino do redirecionamento
statusCode	StatusCode	sim	Código de status do redirecionamento Valores: 301, 302, 307, 308.
resourceId	string	sim	ID do recurso pai.
resourceType	ProxyResourceType	sim	Tipo do recurso pai. Valores: site, function.

Acesso: chave de API com o escopo rules.write.

@owbase/node

import { Client, Proxy, StatusCode, ProxyResourceType } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.createRedirectRule({
    domain: 'example.com',
    url: 'https://example.com',
    statusCode: StatusCode.MovedPermanently,
    resourceId: '<RESOURCE_ID>',
    resourceType: ProxyResourceType.Site,
});

getRule

Obter regra

SDK: só @owbase/node

Obtém uma regra de proxy pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
ruleId	string	sim	ID da regra.

Acesso: chave de API com o escopo rules.read.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.getRule({
    ruleId: '<RULE_ID>',
});

deleteRule

Excluir regra

SDK: só @owbase/node

Exclui uma regra de proxy pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
ruleId	string	sim	ID da regra.

Acesso: chave de API com o escopo rules.write.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.deleteRule({
    ruleId: '<RULE_ID>',
});

updateRuleStatus

Atualizar status da regra

SDK: só @owbase/node

Se ainda não deu certo, tenta de novo a verificação do domínio de uma regra de proxy. Este endpoint dispara a verificação do domínio conferindo os registros DNS. Se a verificação der certo, um certificado TLS é emitido automaticamente para o domínio, de forma assíncrona, em segundo plano.

Parâmetro	Tipo	Obrigatório	Descrição
ruleId	string	sim	ID da regra.

Acesso: chave de API com o escopo rules.write.

@owbase/node

import { Client, Proxy } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const proxy = new Proxy(client);

const result = await proxy.updateRuleStatus({
    ruleId: '<RULE_ID>',
});

---

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.