Consulta da definição de tempo de execução de uma API

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.

api_id

Sim

String

ID da API.

env_id

Não

String

ID do ambiente em que a API é publicada.

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

name

String

Nome da API.

Pode conter de 3 a 64 caracteres, começando com uma letra. Apenas letras, dígitos e sublinhados (_) são permitidos.

type

Integer

Tipo de API.

• 1: API pública

• 2: API privada

Valores de enumeração:

• 1

• 2

version

String

Versão da API.

Máximo: 16

req_protocol

String

Protocolo de solicitação.

• HTTP

• HTTPS

• BOTH: a API pode ser acessada através de HTTP e HTTPS.

Padrão: HTTPS

Valores de enumeração:

• HTTP

• HTTPS

• BOTH

req_method

String

Método de solicitação.

Valores de enumeração:

• GET

• POST

• PUT

• DELETE

• HEAD

• PATCH

• OPTIONS

• ANY

req_uri

String

Solicitar endereço. Ele pode conter parâmetros de solicitação entre colchetes ({}). Por exemplo, /getUserInfo/{userId}. Caracteres especiais, como asteriscos (*), sinais de porcentagem (%), hifens (-) e sublinhados (_), são permitidos. Pode conter um máximo de 512 caracteres e deve estar em conformidade com as especificações de URI.> O valor deve estar em conformidade com as especificações de URI.

auth_type

String

Modo de autenticação da API.

• NONE

• APP

• IAM

• AUTHORIZER

Valores de enumeração:

• NONE

• APP

• IAM

• AUTHORIZER

auth_opt

AuthOpt object

Parâmetro de autenticação de segurança.

cors

Boolean

Indica se o CORS é suportado.

• TRUE: suportado

• FALSE: não suportado

Padrão: false

Valores de enumeração:

• true

• false

match_mode

String

Modo de correspondência de rota.

• SWA: correspondência de prefixo

• NORMAL: correspondência exata

O valor padrão é NORMAL.

Valores de enumeração:

• SWA

• NORMAL

backend_type

String

Tipo de back-end.

• HTTP: back-end da Web

• FUNCTION: back-end do FunctionGraph

• MOCK: back-end fictício

Valores de enumeração:

• HTTP

• FUNCTION

• MOCK

remark

String

Descrição da API. Não pode exceder 255 caracteres.

group_id

String

ID do grupo de APIs ao qual a API pertence.

body_remark

String

Corpo de solicitação da API, que pode ser um exemplo de corpo de solicitação, tipo de mídia ou parâmetros. Certifique-se de que o corpo da solicitação não exceda os caracteres 20.480.

result_normal_sample

String

Exemplo de resposta para uma solicitação bem-sucedida. O valor não pode exceder 20.480 caracteres.

result_failure_sample

String

Exemplo de resposta para uma solicitação com falha O valor não pode exceder 20.480 caracteres.

authorizer_id

String

ID do autorizador personalizado do front-end.

tags

Array of strings

Tags.

O valor pode conter apenas letras, dígitos e sublinhados (_), e deve começar com uma letra. Você pode inserir várias tags e separá-las com vírgulas (,).

Mínimo: 1

Máximo: 128

response_id

String

ID de resposta do grupo.

roma_app_id

String

ID da aplicação de integração.

Atualmente, este parâmetro não é suportado.

domain_name

String

Nome de domínio personalizado vinculado à API.

Atualmente, este parâmetro não é suportado.

tag

String

Tag.

Este campo será depreciado. Você pode usar o campo de tags em vez disso.

content_type

String

Tipo de conteúdo de solicitação:

• application/json

• application/xml

• multipart/form-date

• text/plain

Atualmente, este parâmetro não é suportado.

Valores de enumeração:

• application/json

• application/xml

• multipart/form-date

• text/plain

id

String

ID da API.

group_name

String

Nome do grupo de APIs ao qual a API pertence.

run_env_name

String

Nome do ambiente no qual a API foi publicada.

run_env_id

String

ID do ambiente no qual a API foi publicada.

publish_id

String

ID do registro da publicação.

sl_domain

String

Nome do subdomínio do grupo de APIs.

sl_domains

Array of strings

Nomes do subdomínio que o APIG aloca automaticamente ao grupo da API.

req_params

Array of ReqParam objects

Parâmetros de solicitação.

app_code_auth_type

String

Indica se a autenticação de AppCode está habilitada. Este parâmetro é válido somente se auth_type for definido como App. O valor padrão é DISABLE.

• DISABLE: a autenticação do AppCode está desabilitada.

• HEADER: a autenticação do AppCode está habilitada e o AppCode está localizado no cabeçalho.

Padrão: DISABLE

Valores de enumeração:

• DISABLE

• HEADER

name

String

Nome do parâmetro.

O nome do parâmetro pode conter de 1 a 32 caracteres e deve começar com uma letra. Apenas letras, dígitos, hifens (-), sublinhados (_) e pontos (.) são permitidos.

type

String

Tipo de parâmetro.

Valores de enumeração:

• STRING

• NUMBER

location

String

Localização do parâmetro.

Valores de enumeração:

• PATH

• QUERY

• HEADER

default_value

String

Valor padrão.

sample_value

String

Exemplo de valor.

required

Integer

Indica se o parâmetro é obrigatório. 1: sim 2: não

O valor desse parâmetro é 1 se Localização for definido como PATH e 2 se Localização for definido como outro valor.

Valores de enumeração:

• 1

• 2

valid_enable

Integer

Indica se a verificação de validade está habilitada.

• 1: habilitada

• 2: desabilitada

Padrão: 2

Valores de enumeração:

• 1

• 2

remark

String

Descrição. Não pode exceder 255 caracteres.

enumerations

String

Valor enumerado.

min_num

Integer

Valor mínimo.

Este parâmetro é válido quando tipo é definido como NUMBER.

max_num

Integer

Valor máximo.

Este parâmetro é válido quando tipo é definido como NUMBER.

min_size

Integer

Comprimento mínimo.

Este parâmetro é válido quando tipo é definido como STRING.

max_size

Integer

Comprimento máximo.

Este parâmetro é válido quando tipo é definido como STRING.

regular

String

Regra de validação de expressão regular.

Atualmente, este parâmetro não é suportado.

json_schema

String

Regra de validação JSON.

Atualmente, este parâmetro não é suportado.

pass_through

Integer

Indica se o parâmetro deve ser transferido de forma transparente. 1: sim 2: não

Valores de enumeração:

• 1

• 2

id

String

ID do parâmetro.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

200

OK

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno