Criação de um ambiente
Função
Os provedores de API podem publicar uma API em diferentes ambientes, como os ambientes de desenvolvimento, teste e produção. As informações da API, como a versão, o endereço de solicitação e até a mensagem de solicitação, variam dependendo do ambiente em que uma API é publicada. Por exemplo, a v1.0 de uma API é publicada no ambiente de produção, a v1.1 no ambiente de teste e a v1.2 no ambiente de desenvolvimento. O APIG fornece gerenciamento de ambiente, permitindo que você acesse o APIG em diferentes cenários a um custo mínimo.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/envs
|
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 |
|---|---|---|---|
|
name |
Sim |
String |
Nome do ambiente, que pode conter letras, dígitos e sublinhados (_) e deve começar com uma letra. Mínimo: 3 Máximo: 64 |
|
remark |
Não |
String |
Descrição. Máximo: 255 |
Parâmetros de resposta
Código de status: 201
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
create_time |
String |
Tempo de criação. |
|
name |
String |
Nome do ambiente. |
|
remark |
String |
Descrição. |
|
id |
String |
ID do 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: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitações
{
"name" : "DEV",
"remark" : "Development environment"
}
Exemplo de respostas
Código de status: 201
Criado
{
"create_time" : "2020-07-31T06:41:43.511347628Z",
"name" : "DEV",
"remark" : "Development environment",
"env_id" : "7a1ad0c350844ee69479b47df9a881cb"
}
Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:name. 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: 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 |
|
500 |
Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.
