Origens

As funções do azion/applications que criam, listam, leem, atualizam e excluem as origens de uma application.

Última atualização

Ver como Markdown Configurar agente

Uma origem é o servidor do qual uma application recupera conteúdo. Estas funções do azion/applications criam, listam, leem, atualizam e excluem as origens de uma application. A API identifica uma origem pelo origin_key dela, um UUID, que todas as funções, exceto createOrigin e getOrigins, recebem como originKey.

createOrigin

Cria uma origem em uma application. Uma origem é o servidor do qual a application obtém o conteúdo.

TypeScript
01function createOrigin(params: {
02 applicationId: number;
03 data: ApiCreateOriginPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
dataApiCreateOriginPayloadSimAs configurações da origem. O exemplo define name, origin_type, addresses e host_header.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como a AzionOrigin criada. A API identifica uma origem pela origin_key dela, um UUID, que as outras funções de origem recebem como originKey.

Este exemplo é em JavaScript, porque ApiCreateOriginPayload exige todos os campos da origem, incluindo origin_key e os campos de HMAC, e tipa origin_type como um enum:

JavaScript
01import { createOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Define the data for the new origin
06const newOriginData = {
07 name: 'my-origin',
08 origin_type: 'single_origin',
09 addresses: [{ address: 'example.com' }],
10 host_header: '${host}',
11};
12
13// Create a new origin
14const { data: newOrigin, error } = await createOrigin({ applicationId, data: newOriginData });
15
16if (error) {
17 console.error('Error creating origin:', error);
18} else {
19 console.log('Created origin:', newOrigin.origin_key, newOrigin.name, newOrigin.addresses);
20}

Saída:

Texto
01Created origin: 11111111-1111-1111-1111-111111111111 my-origin [
02 {
03 address: 'example.com',
04 weight: null,
05 server_role: 'primary',
06 is_active: true
07 }
08]

getOrigins

Lista as origens de uma application, uma página por vez.

TypeScript
01function getOrigins(params: {
02 applicationId: number;
03 params?: ApiListOriginsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionOrigin>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
paramsApiListOriginsParamsNãoPaginação: page e page_size.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionOrigin.

TypeScript
01import { getOrigins } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: origins, error } = await getOrigins({ applicationId, params: { page: 1, page_size: 10 } });
06
07if (error) {
08 console.error('Error listing origins:', error);
09} else {
10 console.log(`Found ${origins?.count} origins:`, origins?.results.map((o) => `${o.name} (${o.origin_key})`));
11}

Saída:

Found 1 origins: [ 'my-origin (11111111-1111-1111-1111-111111111111)' ]

getOrigin

Retorna uma origem de uma application pela chave de origem dela.

TypeScript
01function getOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
originKeystringSimA origin_key da origem, um UUID.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como uma AzionOrigin. Uma chave que não corresponde a nenhuma origem retorna error com a mensagem HTTP error! Status: 404 - NOT FOUND e a operação get origin.

TypeScript
01import { getOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { data: origin, error } = await getOrigin({ applicationId, originKey });
07
08if (error) {
09 console.error('Error retrieving origin:', error);
10} else {
11 console.log('Origin details:', origin?.origin_key, origin?.name, origin?.origin_type, origin?.host_header);
12}

Saída:

Origin details: 11111111-1111-1111-1111-111111111111 my-origin single_origin ${host}

updateOrigin

Envia em uma requisição PATCH os campos da origem que você passa.

TypeScript
01function updateOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 data: ApiUpdateOriginRequest;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionOrigin>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
originKeystringSimA origin_key da origem a atualizar.
dataApiUpdateOriginRequestSimOs campos a mudar.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como a AzionOrigin atualizada.

Este exemplo é em JavaScript, porque ApiUpdateOriginRequest exige um id, de que a requisição não precisa:

JavaScript
01import { updateOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { data: updatedOrigin, error } = await updateOrigin({
07 applicationId,
08 originKey,
09 data: { name: 'my-origin-updated' },
10});
11
12if (error) {
13 console.error('Error updating origin:', error);
14} else {
15 console.log('Updated origin:', updatedOrigin.origin_key, updatedOrigin.name);
16}

Saída:

Updated origin: 11111111-1111-1111-1111-111111111111 my-origin-updated

deleteOrigin

Exclui uma origem de uma application pela chave de origem dela.

TypeScript
01function deleteOrigin(params: {
02 applicationId: number;
03 originKey: string;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
originKeystringSimA origin_key da origem a excluir.
optionsAzionClientOptionsNãoOpções de requisição.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê a origem de volta com getOrigin. Um erro 404 confirma a exclusão.

TypeScript
01import { deleteOrigin, getOrigin } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const originKey = '11111111-1111-1111-1111-111111111111'; // Replace with the origin key (a UUID)
05
06const { error: deleteError } = await deleteOrigin({ applicationId, originKey });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading the origin back
09const { error } = await getOrigin({ applicationId, originKey });
10if (error) {
11 console.log(`Origin ${originKey} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting origin:', deleteError);
14}

Saída:

Origin 11111111-1111-1111-1111-111111111111 deleted (read back: HTTP error! Status: 404 - NOT FOUND)

Recursos relacionados

Azion Lib

Os módulos da Azion Lib e o pacote npm em que cada um é distribuído.

Applications

A autenticação do módulo, o envelope de resposta dele e os erros que as funções reportam.

Tipos de application

Os tipos de payload e de resposta que estas funções recebem e retornam.

Origens

A origem da qual uma application recupera conteúdo e as configurações dela.