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 de gateway dedicadas (V2)/ Gerenciamento de API/ Consulta da definição de tempo de execução de uma API

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

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

Ver PDF

Função

Esta API é usada para consultar a definição de tempo de execução de uma API em um ambiente especificado. A definição de tempo de execução de uma API no ambiente RELEASE é consultada se nenhum ambiente for especificado.

A definição de uma API é classificada nos seguintes tipos:

Definição temporária: definição de uma API usada após a última edição da API.
Definição de tempo de execução: instantâneo da definição temporária de uma API capturada quando a API é publicada em um ambiente.

A definição de tempo de execução de uma API é acessada quando a API é chamada em um ambiente.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/runtime/{api_id}

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
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.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
env_id	Não	String	ID do ambiente em que a API é publicada.

Parâmetros de solicitação

**Tabela 3** Parâmetros do cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
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.

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
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.

**Tabela 5** AuthOpt
Parâmetro	Tipo	Descriçã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

**Tabela 6** ReqParam
Parâmetro	Tipo	Descrição
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.

Código de status: 401

**Tabela 7** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 403

**Tabela 8** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 404

**Tabela 9** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 500

**Tabela 10** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

{
  "name" : "Api_http",
  "type" : 1,
  "version" : "V0.0.1",
  "req_protocol" : "HTTPS",
  "req_method" : "GET",
  "req_uri" : "/test/http",
  "auth_type" : "AUTHORIZER",
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "auth_opt" : {
    "app_code_auth_type" : "DISABLE"
  },
  "cors" : false,
  "match_mode" : "NORMAL",
  "backend_type" : "HTTP",
  "remark" : "Web backend API",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "result_normal_sample" : "Example success response",
  "result_failure_sample" : "Example failure response",
  "id" : "5f918d104dc84480a75166ba99efff21",
  "group_name" : "api_group_001",
  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name" : "RELEASE",
  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status	Descrição
200	OK
401	Não autorizado
403	Proibido
404	Não encontrado
500	Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de API

Tópico anterior: Alternação da versão de uma API

Próximo tópico: Consulta de detalhes da versão de 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