Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Nesta página

Mostrar todos

Central de ajuda/ API Gateway/ Referência de API/ APIs compartilhadas de gateway (para usuários existentes)/ Gerenciamento de API/ Modelo de objeto

Modelo de objeto

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Esta seção descreve a API e os modelos de objeto de serviço de back-end.

Operation Type indica a operação que pode ser executada em um campo.
C: criar; U: atualizar; R: ler
Mandatory indica se um campo com o Operation TypeC é obrigatório.

**Tabela 1** Modelo de objeto da API
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID da API	R	-
name	String	Nome da API	CRU	Sim
group_id	String	ID do grupo de APIs ao qual a API pertence	CR	Sim
type	Integer	Tipo da API, que pode ser: 1: público 2: privado	CRU	Sim
status	Integer	Status da API, que pode ser: 1: habilitado 2: desabilitado 3: deletado Valor padrão: 1 Este parâmetro não é usado atualmente.	R	-
version	String	Versão da API	CRU	Não
req_protocol	String	Protocolo de solicitação, que pode ser: HTTP HTTPS BOTH: a API pode ser acessada através de HTTP e HTTPS. Valor padrão: HTTPS	CRU	Não
req_method	String	Método de solicitação, que pode ser: GET POST PUT DELETE HEAD PATCH OPTIONS ANY	CRU	Sim
req_uri	String	Endereço de acesso (URI) da API, excluindo o nome do domínio, o número da porta e o protocolo de solicitação	CRU	Sim
auth_type	String	Modo de autenticação de segurança, que pode ser: NONE APP IAM AUTHORIZER	CRU	Sim
authorizer_id	String	ID do autorizador personalizado do front-end	CRU	Não
match_mode	String	Modo de correspondência de rota, que pode ser: SWA: correspondência de prefixo NORMAL: correspondência exata	CRU	Sim
arrange_necessary	Integer	Indica se a orquestração é necessária. O valor pode ser: 1: sim 2: não Valor padrão: 2	R	-
backend_type	String	Tipo de back-end, que pode ser: HTTP (web) FUNCTION MOCK	CRU	Sim
register_time	Timestamp	Hora em que a API é registrada	R	-
update_time	Timestamp	Hora em que a API foi modificada pela última vez	R	-
remark	String	Descrição da API	CRU	Não
tag	String	Tag da API	CRU	Não
cors	String	Indica se o compartilhamento de recursos de origem cruzada (CORS) é suportado TRUE: suportado FALSE: não suportado Valor padrão: FALSE	CRU	Não
response_id	String	ID da resposta personalizada	CRU	Não

**Tabela 2** Modelo de objeto de back-end da Web
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID de back-end da Web	R	-
status	Integer	Status do back-end da web, que pode ser: 1: habilitado 2: desabilitado 3: deletado Valor padrão: 1 Este parâmetro não é usado atualmente.	R	-
version	String	Versão do back-end da Web	CRU	Não
url_domain	String	Ponto de extremidade de back-end	CRU	Sim
req_protocol	String	Protocolo de solicitação, que pode ser: HTTP HTTPS	CRU	Sim
req_method	String	Método de solicitação, que pode ser: GET POST PUT DELETE HEAD PATCH OPTIONS ANY	CRU	Sim
req_uri	String	Endereço de acesso (URI) do back-end da web	CRU	Sim
timeout	Integer	Duração do tempo limite em milissegundos. Faixa: 1–60.000.	CRU	Sim
front_api_id	String	ID da API	R	-
register_time	Timestamp	Hora em que o back-end da web é registrado	R	-
update_time	Timestamp	Hora em que o back-end da Web foi modificado pela última vez	R	-
remark	String	Descrição do back-end da Web	CRU	Não
vpc_status	Integer	Indica se um canal da VPC deve ser usado. O valor pode ser: 1: sim 2: não	CRU	Não. Nenhum canal de VPC é usado por padrão.
vpc_info	String	Informações do canal da VPC	CRU	Não Este parâmetro só é necessário quando vpc_status é definido como 1.
authorizer_id	String	ID do autorizador personalizado de back-end	CRU	Não

**Tabela 3** Modelo de objeto de back-end simulado
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID de back-end simulado	R	-
front_api_id	String	ID da API	R	-
status	Integer	Status do back-end simulado, que pode ser: 1: habilitado 2: desabilitado 3: deletado Valor padrão: 1 Este parâmetro não é usado atualmente.	R	-
version	String	Versão do back-end de simulação	CRU	Não
result_content	String	Resposta simulada	CRU	Não
register_time	Timestamp	Hora em que o back-end simulado é registrado	R	-
update_time	Timestamp	Hora em que o back-end simulado foi modificado pela última vez	R	-
remark	String	Descrição do back-end simulado	CRU	Não

**Tabela 4** Modelo de objeto de back-end do FunctionGraph
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID da função	R	-
front_api_id	String	ID da API	R	-
status	Integer	Status da função, que pode ser: 1: habilitado 2: desabilitado 3: deletado Valor padrão: 1 Este parâmetro não é usado atualmente.	R	-
version	String	Versão da função	CRU	Não
function_urn	String	Função URN	CRU	Sim
invocation_type	String	Modo de invocação, que pode ser async ou sync	CRU	Sim
timeout	Integer	Duração do tempo limite em milissegundos. Faixa: 1–60.000.	CRU	Sim
register_time	Date	Hora em que a função é registrada	R	-
update_time	Date	Hora em que a função foi modificada pela última vez	R	-
remark	String	Descrição da função	CRU	Não

**Tabela 5** Modelo de objeto de parâmetro de solicitação
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID do parâmetro	R	-
front_api_id	String	ID da API	R	-
name	String	Nome do parâmetro	CRU	Sim
type	String	Tipo de parâmetro, que pode ser: string number	CRU	Sim
location	String	Localização do parâmetro, que pode ser: PATH QUERY HEADER FORMDATA	CRU	Sim
default_value	String	Valor padrão	CRU	Não
sample_value	String	Exemplo de valor	CRU	Não
required	Integer	Se o parâmetro é obrigatório 1: sim 2: não	CRU	Sim
valid_enable	Integer	Se a verificação de validade está habilitada 1: sim 2: não	CRU	Sim
remark	String	Descrição do parâmetro	CRU	Não
enumerations	String	Valor enumerado	CRU	Não
min_num	String	Valor mínimo	CRU	Não
max_num	String	Valor máximo	CRU	Não
min_size	Integer	Comprimento mínimo	CRU	Não
max_size	Integer	Comprimento máximo	CRU	Não
regular	String	Regra de verificação regular (atualmente não suportada)	CRU	Não
json_schema	String	Regra de verificação JSON (atualmente não suportada)	CRU	Não

**Tabela 6** Modelo de objeto de parâmetro de back-end
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID do parâmetro	R	-
front_api_id	String	ID da API	R	-
req_param_id	String	ID do parâmetro de solicitação para o qual o parâmetro de back-end é mapeado	R	-
name	String	Nome do parâmetro	CRU	Sim
location	String	Localização do parâmetro, que pode ser: PATH QUERY HEADER FORMDATA	CRU	Sim
origin	String	Tipo de parâmetro, que pode ser: REQUEST CONSTANT SYSTEM	CRU	Sim
value	String	Valor do parâmetro Se origin estiver definida como REQUEST, o valor é o nome do parâmetro de solicitação. Se origin estiver definida como SYSTEM, o valor será o nome do parâmetro gateway. Se origin estiver definido como CONSTANT, o valor é o valor real do parâmetro back-end.	CRU	Não
remark	String	Descrição do parâmetro	CRU	Não
policy_id	String	ID da condição de política associada	CRU	Não

**Tabela 7** Modelo de objeto de política de back-end da Web
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID de back-end	R	-
front_api_id	String	ID da API	R	-
name	String	Nome do back-end	CRU	Sim
url_domain	String	Ponto de extremidade de back-end	CRU	Sim
req_protocol	String	Protocolo de solicitação, que pode ser: HTTP HTTPS	CRU	Sim
req_method	String	Método de solicitação, que pode ser: GET POST PUT DELETE HEAD PATCH OPTIONS ANY	CRU	Sim
req_uri	String	Endereço de acesso (URI) do back-end da web	CRU	Sim
timeout	Integer	Duração do tempo limite em milissegundos. Faixa: 1–60.000.	CRU	Não
vpc_status	Integer	Indica se um canal da VPC deve ser usado. O valor pode ser: 1: sim 2: não	CRU	Não. Nenhum canal de VPC é usado por padrão.
vpc_info	String	Informações do canal da VPC	CRU	Não Este parâmetro só é necessário quando vpc_status é definido como 1.
effect_mode	String	Modo efetivo da política de back-end ALL ANY	CRU	Sim

**Tabela 8** Modelo de objeto de política de back-end simulado
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID de back-end	R	-
front_api_id	String	ID da API	R	-
name	String	Nome do back-end	CRU	Sim
result_content	String	Resposta simulada	CRU	Não
effect_mode	String	Modo efetivo da política de back-end ALL ANY	CRU	Sim

**Tabela 9** Modelo de objeto de back-end de política do FunctionGraph
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID de back-end	R	-
front_api_id	String	ID da API	R	-
name	String	Nome do back-end	CRU	Sim
version	String	Versão da função	CRU	Não
function_urn	String	Função URN	CRU	Sim
invocation_type	String	Modo de invocação, que pode ser async ou sync	CRU	Sim
timeout	Integer	Duração do tempo limite em milissegundos. Faixa: 1–60.000.	CRU	Sim
effect_mode	String	Modo efetivo da política de back-end ALL ANY	CRU	Sim

**Tabela 10** Modelo de objeto de condição de política de back-end
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
id	String	ID da condição da política de back-end	R	-
condition_type	String	Tipo de condição. Opções: exact: correspondência exata enum: enumeração pattern: expressão regular	CRU	Não
condition_value	String	Valor da condição	CRU	Sim
condition_origin	String	Fonte da condição. Opções: param: parâmetro de entrada source: endereço IP de origem	CRU	Sim
req_param_id	String	ID do parâmetro de entrada	R	-
policy_backend_id	String	ID da política de back-end	CRU	Sim

**Tabela 11** Modelo de objeto de parâmetro de modo de autenticação
Parâmetro	Tipo	Descrição	Tipo de operação	Obrigatório
app_code_auth_type	String	Indica se a autenticação AppCode está habilitada. Esse parâmetro é válido somente quando auth_type é 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.	CRU	-

Tópico principal: Gerenciamento de API

Tópico anterior: Gerenciamento de API

Próximo tópico: Registro de uma API

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar