Edge Functions Instances

Edite no GitHub

Com a API de Edge Functions Instances você pode consultar, remover ou atualizar configurações existentes, bem como criar novos ajustes.

  1. Obter lista de Edge Functions Instances
  2. Obter dados de Edge Functions Instances
  3. Deletar Edge Functions Instances
  4. Criar novo Edge Functions Instances
  5. Sobrescrever Edge Functions Instances existente
  6. Atualizar campos de Edge Functions Instances

1. Obter lista de Edge Functions Instances

Este retorno gera uma lista de Edge Functions Instances.

GET /edge_applications/:edge_application_id:/functions_instances

Permissão necessária: View Edge Application

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
:edge_application_id
*obrigatório
O id da Edge Application que se pretende consultar. path number

Exemplo de Requisição

GET /edge_applications/1570451232/functions_instances 
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "count": 3,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
    "results": [
        {
            "id": 522,
            "edge_function_id": 13,
            "name": "Hello World",
            "args": {
                "param": {
                    "body": "Azion - Move to the Edge",
                    "http_status": 200
                }
            }
        },
        {
            "id": 565,
            "edge_function_id": 312,
            "name": "My Hello World",
            "args": {
                "param": {
                    "body": "It works!",
                    "http_status": 200
                }
            }
        },
        {
            "id": 2360,
            "edge_function_id": 13,
            "name": "Edge Function",
            "args": {}
        }
    ]
}

2. Obter dados de Edge Functions Instances{#obter-dados-de-functions-instances}

Fornece detalhes de Edge Functions Instances. As informações que são retornadas por este comando se referem as edge function instances de uma Edge Application.

GET /edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:

Permissão necessária: View Edge Application

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
:edge_application_id
*obrigatório
O id da edge application que se pretende consultar. path number
:functions_instances_id
*obrigatório
O id da edge function instance que se pretende consultar. path number

Exemplo de Requisição

GET /edge_applications/161231227352/functions_instances/1031231
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "results": {
        "id": 565,
        "edge_function_id": 312,
        "name": "My Hello World",
        "args": {
            "param": {
                "body": "It works!",
                "http_status": 200
            }
        }
    },
    "schema_version": 3
}

3. Deletar Edge Functions Instances

Este retorno remove um Edge Functions Instances. A operação é definitiva, ou seja, não existe nenhuma forma de se realizar rollback dessas informações após a confirmação pelo usuário.

Todas as informações associadas a essa Edge Functions Instances também serão removidas.

Caso alguma Edge Function Instance esteja sendo utilizada por alguma regra no Rules Engine, não será possível excluir a edge function instance até a regra ser deletada ou ser inativada.

A API não exige confirmação para a execução dessa ação.

DELETE /edge_applications/:edge_application_id:/functions_instances/:functions_instance_id:

Permissão necessária: Edit Edge Application

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
:edge_application_id
*obrigatório
O id da edge application que se pretende excluir. path number
:functions_instances_id
*obrigatório
O id de edge function instance que se pretende excluir. path number

Exemplo de Requisição

DELETE /edge_applications/16076123352/functions_instances/10764
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

HTTP/2 204

4. Criar novo Edge Functions Instances

Possibilita a criação de um novo Edge Functions Instances.

POST /edge_application/:edge_application_id:/functions_instances

Permissão necessária: Edit Edge Application

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão header string;
application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
:edge_application_id
*obrigatório
O id da edge application que se pretende criar. path number

Exemplo de Requisição

POST /edge_applications/:edge_application_id:/functions_instances
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
		"name": "Criar Edge Functions Instance",
  		"edge_function_id": 13,
  		"args": {
            "param": {
                "body": "It works!",
                "http_status": 200
		}
	}
}

Exemplo de Resposta

{
    "results": {
        "edge_function_id": 13,
        "name": "Criar Edge Functions Instance",
        "args": {
        	"param": {
                "body": "It works!",
                "http_status": 200
        },
        "id": 2361
    },
    "schema_version": 3
}

5. Sobrescrever Edge Functions Instances existente

Este retorno sobrescreve todos os campos de Edge Functions Instances, preservando o id.

Se você deseja atualizar somente alguns campos, sem alterar o valor dos demais, considere utilizar o método PATCH ao invés de PUT.

PUT /edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:

Permissão necessária: Edit Edge Applications

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
:edge_application_id
*obrigatório
O id da Edge Application que se pretende sobrescrever. path number
:functions_instances_id
*obrigatório
O id de edge function instance que se pretende sobrescrever. path number

Exemplo de Requisição

PUT /edge_applications/16076123352/functions_instances/10764
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
		"name": "Sobrescrever Edge Functions Instance",
  		"edge_function_id": 13,
  		"args": {
            "param": {
                "body": "It works!",
                "http_status": 200
		}
	}
}

Exemplo de Resposta

{
    "results": {
        "edge_function_id": 13,
        "name": "Sobrescrever Edge Functions Instance",
        "args": {
        	"param": {
                "body": "It works!",
                "http_status": 200
        },
        "id": 2361
    },
    "schema_version": 3
}

6. Atualizar campos de Edge Functions Instances

Este retorno atualiza um ou mais campos de um Edge Functions Instances, preservando o valor dos campos não informados.

PATCH /edge_applications/:edge_application_id:/functions_instances/:functions_instances_id:

Permissão necessária: Edit Edge Application

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão header string;

application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
:edge_application_id
*obrigatório
O id da edge application que se pretende atualizar. path number
:functions_instances_id
*obrigatório
O id de edge function instance que se pretende atualizar. path number

Exemplo de Requisição

PATCH /edge_applications/16076123352/functions_instances/10764
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
		"name": "Atualizar Edge Functions Instance",
  		"edge_function_id": 13,
  		"args": {
            "param": {
                "body": "It works!",
                "http_status": 200
		}
	}
}

Exemplo de Resposta

{
    "results": {
        "edge_function_id": 13,
        "name": "Atualizar Edge Functions Instance",
        "args": {
        	"param": {
                "body": "It works!",
                "http_status": 200
        },
        "id": 2361
    },
    "schema_version": 3
}

Não encontrou o que procurava? Abra um ticket.