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

Consulta de detalhes de variáveis

Função

Esta API é usada para consultar os detalhes de uma variável de ambiente.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_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.

env_variable_id

Sim

String

ID da variável de ambiente.

Parâmetros de solicitação

Tabela 2 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 3 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

variable_value

String

O valor da variável pode conter de 1 a 255 caracteres. Somente letras, dígitos e caracteres especiais (_-/.:) são permitidos.

env_id

String

ID do ambiente.

Mínimo: 1

Máximo: 65

group_id

String

ID do grupo da API.

Mínimo: 1

Máximo: 65

variable_name

String

Nome da variável, que pode conter de 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#" nas definições da 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.

id

String

ID da variável de ambiente.

Código de status: 401

Tabela 4 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 5 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 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: 500

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.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "variable_value" : "192.168.1.5",
  "env_id" : "7a1ad0c350844ee69479b47df9a881cb",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "id" : "25054838a624400bbf2267cf5b3a3f70",
  "variable_name" : "address"
}

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.3011",
  "error_msg" : "The environment variable does not exist, id: 25054838a624400bbf2267cf5b3a3f70"
}

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.