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 de gateway dedicadas (V2)/Gerenciamento de recursos de gateway/Consulta de recursos do gateway

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

Consulta de recursos do gateway

Função

Esta API é usada para consultar os recursos de um gateway. Se um gateway não oferecer suporte aos recursos listados na tabela a seguir, entre em contato com o suporte técnico para atualizar o gateway.

A tabela a seguir lista os recursos de gateway suportados.

Nome de recursos	Descrição	Configurável
lts	Relatórios de logs de acesso Shubao	Sim
gateway_responses	Respostas de gateway personalizadas	Não
ratelimit	Configuração do limite de solicitação	Sim
request_body_size	Configuração do tamanho máximo do corpo da solicitação	Sim
backend_timeout	Configuração máxima de tempo limite de back-end	Sim
app_token	Autenticação app_token	Sim
app_api_key	Autenticação app_api_key	Sim
app_basic	Autenticação app_basic	Sim
app_secret	Autenticação app_secret	Sim
app_jwt	Autenticação app_jwt	Sim
public_key	Assinaturas de back-end public_key	Sim
backend_token_allow	Permitir que os locatários transmitam tokens de forma transparente para o back-end	Sim
sign_basic	Chaves básicas de assinatura	Não
multi_auth	Autenticação de dois fatores	Não
backend_client_certificate	Autenticação bidirecional de back-end	Sim
ssl_ciphers	Conjuntos de cifras HTTPS	Sim
route	Rotas personalizadas	Não
cors	Plug-ins	Não
real_ip_from_xff	Usar o cabeçalho X-Forwarded-For para especificar endereços IP de origem para controle de acesso e limitação de solicitações	Sim
app_route	Acesso ao endereço IP	Sim
vpc_name_modifiable	Modificação do nome do canal do balanceamento de carga	Sim
default_group_host_trustlist	Acesso ao grupo DEFAULT a partir de endereços IP que não são endereços de acesso de entrada do gateway atual	Sim
throttle_strategy	Políticas de algoritmo de limitação de solicitações	Sim
custom_log	Impressão de cabeçalhos de solicitação personalizados, cadeia de consulta e cookies em logs	Sim
real_ip_header_getter	Usar um cabeçalho personalizado para obter endereços IP de origem	Sim
policy_cookie_param	Usar cookies em condições de política de back-end	Sim
app_quota	Cotas de clientes	Não
app_acl	Políticas de limitação de solicitações	Não
set_resp_headers	Plug-ins de gerenciamento de cabeçalho de resposta	Não
vpc_backup	Canais da VPC principais/em espera	Não
sign_aes	Chaves de assinatura AES	Não
kafka_log	Adicionar, excluir, modificar e consultar plug-ins de envio de log do Kafka	Não
backend_retry_count	Configuração de repetição de back-end	Não
policy_sys_param	Usar parâmetros do sistema em condições de política de back-end	Não
breaker	Disjuntores	Não
content_type_configurable	Retornar o tipo de parâmetro de solicitação (Content-Type) ao consultar APIs	Não
rate_limit_plugin	Plug-ins de limitação de solicitação	Não
breakerv2	Disjuntores para serviços degradantes em caso de sobrecarga	Não
sm_cipher_type	Criptografar dados sensíveis locais com algoritmos criptográficos comerciais	Não
rate_limit_algorithm	Troca do algoritmo de limitação de solicitação	Não

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/features

**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.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
offset	Não	Long	Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0. Padrão: 0
limit	Não	Integer	Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500. Mínimo: 1 Máximo: 500 Padrão: 20

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
size	Integer	Comprimento da lista de recursos retornados.
total	Long	Número de recursos que atendem às condições de consulta.
features	Array of FeatureInfo objects	Lista de recursos.

**Tabela 5** FeatureInfo
Parâmetro	Tipo	Descrição
id	String	ID dos recursos.
name	String	Nome de recursos. Mínimo: 1 Máximo: 64
enable	Boolean	Indica se o recurso deve ser ativado.
config	String	Configuração de parâmetros.
instance_id	String	ID do gateway.
update_time	String	Tempo de atualização do recurso.

Código de status: 400

**Tabela 6** 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: 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

{
  "total" : 1,
  "size" : 1,
  "features" : [ {
    "config" : "on",
    "enable" : true,
    "id" : "db9a9260cd3e4a16a9b5747a65d3ffaa",
    "instance_id" : "eddc4d25480b4cd6b512f270a1b8b341",
    "name" : "app_api_key",
    "update_time" : "2020-08-24T01:17:31.041984Z"
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

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.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

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
400	Solicitação inválida
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 recursos de gateway

Tópico anterior: Configuração de um recurso para um gateway

Próximo tópico: Gerenciamento da configuração

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.