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.

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

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

Ver PDF

Consulta de detalhes da API

Função

Esta API é usada para consultar os detalhes de uma API especificada.

URI

A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.

**Tabela 1** Método de solicitação HTTP/HTTPS e URI
Método de solicitação	URI
GET	/v1.0/apigw/apis/{id}

A tabela a seguir lista os parâmetros no URI.

**Tabela 2** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
id	Sim	String	ID da API

Solicitação

N/D

Resposta

**Tabela 3** Descrição do parâmetro
Parâmetro	Tipo	Descrição
id	String	ID da API
name	String	Nome da API
group_id	String	ID do grupo de APIs ao qual a API pertence
group_name	String	Nome do grupo de APIs ao qual a API pertence
status	Integer	Status da API
type	Integer	Tipo de API
version	String	Versão da API
req_protocol	String	Protocolo de solicitação
req_method	String	Método de solicitação
req_uri	String	Endereço de acesso
auth_type	String	Modo de autenticação de segurança
auth_opt	Object	Parâmetro de modo de autenticação de segurança
authorizer_id	String	ID do autorizador personalizado do front-end
match_mode	String	Modo de correspondência
register_time	Timestamp	Hora em que a API é registrada
update_time	Timestamp	Hora em que a API foi modificada pela última vez
remark	String	Descrição da API
bakend_type	String	Tipo de back-end
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 de publicação
arrange_necessary	Integer	Indica se a orquestração é necessária.
tag	String	Tag de nome de serviço, que deve ser descartada
tags	[]String	Tags da API
cors	Bool	Indica se o CORS é suportado.
body_remark	String	Descrição do corpo da solicitação da API, que pode ser um exemplo de corpo da solicitação, tipo de mídia ou informações de parâmetro
result_normal_sample	String	exemplo de resposta para uma solicitação bem-sucedida
result_failure_sample	String	Exemplo de resposta para uma solicitação com falha
response_id	String	ID da resposta do gateway
backend_api	Dicionário	Detalhes do back-end da Web
mock_info	Dicionário	Detalhes do back-end fictício
func_info	Dicionário	Detalhes do back-end do FunctionGraph
req_params	Dicionário	Lista de parâmetros de solicitação
backend_params	Dicionário	Lista de parâmetros de back-end
policy_https	Dicionário	Lista de políticas de back-end da Web
policy_mocks	Dicionário	Lista de política de back-end fictícia
policy_functions	Dicionário	Lista de políticas de back-end do FunctionGraph

**Tabela 4** Descrição do parâmetro de backend_api
Parâmetro	Tipo	Descrição
id	String	ID de back-end da Web
status	Integer	Status do back-end da Web
url_domain	String	Ponto de extremidade de back-end
version	String	Versão de back-end da Web
req_protocol	String	Protocolo de solicitação
req_method	String	Método de solicitação
req_uri	String	Endereço de acesso
timeout	Integer	Duração do tempo limite em milissegundos
register_time	Timestamp	Hora em que o back-end da web é registrado
update_time	Timestamp	Hora em que o back-end da Web foi modificado pela última vez
remark	String	Descrição do back-end da Web
vpc_status	String	Indica se um canal da VPC deve ser usado.
vpc_info	String	Informações do canal da VPC
authorizer_id	String	ID do autorizador personalizado de back-end

**Tabela 5** Descrição do parâmetro de mock_info
Parâmetro	Tipo	Descrição
id	String	ID de back-end simulado
status	Integer	Status de back-end fictício
version	String	Versão de backend fictícia
result_content	String	Resposta fictícia
register_time	Timestamp	Hora em que o back-end simulado é registrado
update_time	Timestamp	Hora em que o back-end simulado foi modificado pela última vez
remark	String	Descrição do back-end fictício

**Tabela 6** Descrição do parâmetro func_info
Parâmetro	Tipo	Descrição
id	String	ID da função
status	Integer	Status da função
version	String	Versão da função
function_urn	String	Função URN
invocation_type	String	Modo de invocação, que pode ser async ou sync
register_time	Timestamp	Hora em que a função é registrada
update_time	Timestamp	Hora em que a função foi atualizada pela última vez
timeout	Integer	Duração do tempo limite em milissegundos
remark	String	Descrição da função

**Tabela 7** Descrição do parâmetro de req_params
Parâmetro	Tipo	Descrição
id	String	ID do parâmetro
name	String	Nome do parâmetro
type	String	Tipo de parâmetro
location	String	Localização do parâmetro
default_value	String	Valor padrão
sample_value	String	Exemplo de valor
required	Integer	Indica se o parâmetro é obrigatório. O valor pode ser: 1: sim 2: não
valid_enable	Integer	Indica se a verificação de validade está habilitada.
remark	String	Descrição do parâmetro
enumerations	String	Valor enumerado
min_num	Integer	Valor mínimo, que é válido quando o tipo de parâmetro é NUMBER
max_num	Integer	Valor máximo, que é válido quando o tipo de parâmetro é NUMBER
min_size	Integer	Comprimento mínimo
max_size	Integer	Comprimento máximo
regular	String	Regra de verificação regular (atualmente não suportada)
json_schema	String	Regra de verificação JSON (atualmente não suportada)

**Tabela 8** Descrição do parâmetro de backend_params
Parâmetro	Tipo	Descrição
id	String	ID do parâmetro
req_param_id	String	ID do parâmetro de solicitação para o qual o parâmetro de back-end é mapeado
name	String	Nome do parâmetro
location	String	Localização do parâmetro
origin	String	Tipo de parâmetro
value	String	Valor do parâmetro
remark	String	Descrição do parâmetro

**Tabela 9** Descrição do parâmetro policy_https
Parâmetro	Tipo	Descrição
id	String	ID da política de back-end
name	String	Nome do back-end
url_domain	String	Ponto de extremidade do back-end da política
req_protocol	String	Protocolo de solicitação
req_method	String	Método de solicitação
req_uri	String	Endereço de acesso
timeout	Integer	Duração do tempo limite em milissegundos
vpc_status	String	Indica se um canal da VPC deve ser usado.
vpc_info	String	Informações do canal da VPC
effect_mode	String	Modo efetivo da política de back-end
conditions	Dicionário	Lista de condições de política
backend_params	Dicionário	Lista de parâmetros de back-end

**Tabela 10** Descrição do parâmetro policy_mocks
Parâmetro	Tipo	Descrição
id	String	ID da política de back-end
name	String	Nome do back-end
result_content	String	Resposta fictícia
effect_mode	String	Modo efetivo da política de back-end
conditions	Dicionário	Lista de condições de política
backend_params	Dicionário	Lista de parâmetros de back-end

**Tabela 11** Descrição do parâmetro de policy_functions
Parâmetro	Tipo	Descrição
id	String	ID da política de back-end
name	String	Nome do back-end
version	String	Versão da função
function_urn	String	Função URN
invocation_type	String	Modo de invocação, que pode ser async ou sync
timeout	Integer	Duração do tempo limite em milissegundos
effect_mode	String	Modo efetivo da política de back-end
conditions	Dicionário	Lista de condições de política
backend_params	Dicionário	Lista de parâmetros de back-end

**Tabela 12** Descrição do parâmetro das condições
Parâmetro	Tipo	Descrição
id	String	ID da condição da política de back-end
condition_type	String	Tipo de condição
condition_value	String	Valor da condição
condition_origin	String	Fonte da condição
req_param_name	String	Nome do parâmetro de entrada
req_param_id	String	ID do parâmetro de entrada
req_param_location	String	Localização do parâmetro de entrada

**Tabela 13** Descrição do parâmetro de auth_opt
Parâmetro	Tipo	Descrição
app_code_auth_type	String	Indica se a autenticação AppCode está habilitada.

Exemplo de resposta:

{
  "name": "test",
  "type": 1,
  "version": "V0.0.1",
  "req_protocol": "HTTPS",
  "req_method": "GET",
  "req_uri": "/test/{tenant_id}",
  "auth_type": "APP",
  "auth_opt": {
    "app_code_auth_type": "DISABLE"
  },
  "tags": ["APIG-SN-test", "test"],
  "cors": false,
  "match_mode": "NORMAL",
  "backend_type": "HTTP",
  "group_id": "f71f69876f90456ca6fd18ed012fdc11",
  "result_normal_sample": "hello world!",
  "id": "81efcfd94b8747a0b21e8c04144a4e8c",
  "status": 1,
  "arrange_necessary": 2,
  "register_time": "2018-08-15T03:41:11.0239936Z",
  "update_time": "2018-08-15T03:41:11.0239936Z",
  "group_name": "group0002",
  "backend_api": {
    "url_domain": "xxxxxxxxxxx",
    "req_protocol": "HTTP",
    "req_method": "GET",
    "req_uri": "/test",
    "timeout": 1000,
    "vpc_status": 2,
    "id": "3442ffd031814e3a8f133a9f1ea08453",
    "status": 1,
    "register_time": "2018-08-15T03:41:11.1019236Z",
    "update_time": "2018-08-15T03:41:11.1019236Z"
  },
  "req_params": [
    {
      "name": "tenant_id",
      "type": "STRING",
      "location": "PATH",
      "required": 1,
      "valid_enable": 2,
      "id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "type": "STRING",
      "location": "QUERY",
      "required": 2,
      "valid_enable": 2,
      "id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ],
  "backend_params": [
    {
      "name": "tenant_id",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "tenant_id",
      "id": "44e03de2351e43a8b18ba9ec1e71d2e9",
      "req_param_id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "city",
      "id": "b60fbcb5b86f4f5c8705c445b9bd6325",
      "req_param_id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ],
  "policy_https": [{
    "conditions": [{
      "id": "44e03de2351e43a8b18ba9ec1e71d2e9",
      "condition_type": "pattern",
      "condition_value": "^[0-9]$",
      "condition_origin": "param",
      "req_param_name": "project_id",
      "req_param_id": "b60fbcb5b86f4f5c8705c445b9sda325",
      "req_param_location": "PATH"
    }],
    "backend_params": [{
      "name": "project_id",
      "value": "bbbb",
      "location": "QUERY",
      "origin": "REQUEST",
      "id": "44e03de2351e43a8b18ba9ec1e71d2e8",
      "req_param_id": "593c5560e0924e00af08fb458f850ecb"
    }],
    "effect_mode": "ANY",
    "id": "44e03de2351e43a8b18ba9ec1e71d2e8",
    "name": "policy001",
    "req_method": "GET",
    "req_protocol": "http",
    "req_uri": "/test/policy",
    "timeout": 10000,
    "url_domain": "xxxxxxxxxxx",
    "vpc_status": 2
  }]
}