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/ Criação de uma variável de ambiente
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Criação de uma variável de ambiente

Função

A publicação de uma API em diferentes ambientes pode envolver várias variáveis de ambiente, como o endereço de implementação do serviço da API e a versão da solicitação.

Defina variáveis de ambiente ao criar uma API. Quando a API é chamada, as variáveis de ambiente serão substituídas pelos valores das variáveis para distinguir os ambientes.

As variáveis de ambiente são definidas para um grupo de APIs e se aplicam a todas as APIs do grupo.

  1. Os nomes de variáveis de ambiente devem ser exclusivos para um grupo de APIs no mesmo ambiente.
  2. Os nomes das variáveis de ambiente diferenciam maiúsculas de minúsculas. Por exemplo, ABC e abc são duas variáveis diferentes.
  3. APIs que usam variáveis de ambiente não podem ser depuradas.
  4. É preciso colocar uma variável de ambiente em sinais numéricos (#) para que ela possa ser substituída pelo valor real do ambiente no qual a API é publicada. Por exemplo, se o URL de uma API for https://#address#:8080 e o valor do address da variável for 192.168.1.5 no ambiente RELEASE, o URL real da API será https://192.168.1.5:8080 após a publicação.

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

POST

/v1.0/apigw/env-variables

Solicitação

Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

env_id

Sim

String

ID do ambiente

group_id

Sim

String

ID do grupo da API

variable_name

Sim

String

Nome da variável

Um nome de variável consiste em 3 a 32 caracteres, começando com uma letra. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos. O nome da variável é equivalente a #Name# em uma definição de API. Os caracteres entre os sinais numéricos diferenciam maiúsculas de minúsculas. O nome da variável será substituído pelo valor da variável após a publicação da API.

variable_value

Sim

String

Valor variável

Um valor variável consiste em 1–255 caracteres. Somente letras, dígitos e caracteres especiais (_-/.:) são permitidos.

Exemplo de solicitação:

{
	"env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
	"group_id": "73c58022-f20d-495a-a188-85d718647f09",
	"variable_name": "address",
	"variable_value": "192.168.1.5"
}

Resposta

Tabela 3 Descrição do parâmetro

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:

{
	"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 4 Códigos de status

Código de status

Descrição

201

Criado

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno