Criação de uma variável
Função
A publicação de uma API em diferentes ambientes pode envolver diversas variáveis, como endereço de implementação do serviço da API e versão da solicitação.
Você pode definir variáveisde 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.
-
Os nomes de variáveis de ambiente devem ser exclusivos para um grupo de APIs no mesmo ambiente.
-
Os nomes das variáveis de ambiente diferenciam maiúsculas de minúsculas. Por exemplo, ABC e abc são duas variáveisdiferentes.
-
APIs que usam variáveis de ambiente não podem ser depuradas.
-
É 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 endereço variável for 192.168.1.5 no ambiente RELEASE, o URL real da API será https://192.168.1.5:8080 depois de publicar.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/env-variables
|
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. |
Parâmetros 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âmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
variable_value |
Sim |
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 |
Sim |
String |
ID do ambiente. Mínimo: 1 Máximo: 65 |
|
group_id |
Sim |
String |
ID do grupo da API. Mínimo: 1 Máximo: 65 |
|
variable_name |
Sim |
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. |
Parâmetros de resposta
Código de status: 201
|
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: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 401
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitações
{
"variable_name" : "address",
"variable_value" : "192.168.1.5",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600"
}
Exemplo de respostas
Código de status: 201
Criado
{
"variable_value" : "192.168.1.5",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"id" : "25054838a624400bbf2267cf5b3a3f70",
"variable_name" : "address"
}
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.3003",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}
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 |
|---|---|
|
201 |
Criado |
|
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.
