Consulta de ambientes
Função
Esta API é usada para consultar ambientes.
URI
GET /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âmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
offset |
Não |
Long |
Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0. Padrão: 0 |
limit |
Não |
Integer |
Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500. Mínimo: 1 Máximo: 500 Padrão: 20 |
name |
Não |
String |
Nome do ambiente. |
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âmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
|---|---|---|
size |
Integer |
Comprimento da lista de recursos retornados. |
total |
Long |
Número de recursos que atendem às condições de consulta. |
envs |
Array of EnvInfo objects |
Lista de ambiente. |
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
Nenhum
Exemplo de respostas
Código de status: 200
OK
{
"total" : 2,
"size" : 2,
"envs" : [ {
"create_time" : "2019-02-12T19:42:19.914989Z",
"name" : "RELEASE",
"remark" : "xxx",
"id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
}, {
"create_time" : "2020-07-31T06:41:43Z",
"name" : "DEV",
"remark" : "Development environment",
"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 |
|---|---|
200 |
OK |
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.
