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 variáveis de ambiente/ Consulta de uma lista de variáveis de ambiente
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de uma lista de variáveis de ambiente

Função

Esta API é usada para consultar a lista de todas as variáveis de ambiente em um grupo de APIs.

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/env-variables[?page_size, page_no, env_id, group_id, variable_name]
  • Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
  • As condições de consulta incluem: env_id, group_id, variable_name, page_size e page_no.
Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

env_id

Não

String

ID do ambiente

group_id

Sim

String

ID do grupo da API

variable_name

Não

String

Nome da variável

page_size

Não

Integer

Número de registros exibidos em cada página. O valor padrão é 20.

page_no

Não

Integer

Número da página. O valor padrão é 1.

precise_search

Não

String

Nome do parâmetro (variable_name) para correspondência exata

Solicitação

N/D

Resposta

Tabela 3 Descrição do parâmetro

Parâmetro

Tipo

Descrição

variables

Dicionário

Lista de variáveis de ambiente

total

Integer

Número de variáveis de ambiente que correspondem às condições de consulta

size

Integer

Comprimento da lista de variáveis de ambiente retornadas
Tabela 4 Descrição do parâmetro das variáveis

Parâmetro

Tipo

Descrição

id

String

ID da variável de ambiente

env_id

String

ID do ambiente

group_id

String

ID do grupo da API

variable_name

String

Nome da variável

variable_value

String

Valor variável

Exemplo de resposta:

{
	"total": 2,
	"size": 2,
	"variables": [{
		"id": "09ab8135-7224-40b9-bf5d-107f2a09d409",
		"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"variable_name": "port",
		"variable_value": "8080"
	},
	{
		"id": "104185e5-3e8f-4c63-a7e5-ef4117bf870c",
		"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
		"group_id": "73c58022-f20d-495a-a188-85d718647f09",
		"variable_name": "address",
		"variable_value": "192.168.1.5"
	}]
}

Códigos de status

Tabela 5 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