Consulta de cotas
Função
Função Essa API é usada para consultar a cota de seus recursos, incluindo serviços do ponto de extremidade da VPC e pontos de extremidade da VPC.
URI
GET /v1/{project_id}/quotas
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
type |
Não |
String |
Especifica o tipo de recurso. ● endpoint_service ● endpoint |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. Ele pode ser obtido chamando a API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
|
Content-Type |
Sim |
String |
Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as APIs usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
quotas |
ResourcesResp object |
Estrutura de resposta da API para consulta de cotas |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
type |
String |
Especifica o tipo de recurso. Você pode consultar a cota de um recurso especificado por tipo de recurso. ● endpoint_service ● endpoint |
|
used |
Integer |
Especifica o número dos recursos criados. O valor varia de 0 ao valor da cota. |
|
quota |
Integer |
Especifica a cota de recursos. O valor varia do valor da cota padrão ao valor máximo da cota. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 401
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 405
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 406
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 407
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 408
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 409
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 501
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 502
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 503
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 504
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Exemplos de solicitações
-
GET https://{endpoint}/v1/{project_id}/quotas?type=endpoint -
GET https://{endpoint}/v1/{project_id}/quotas?type=endpoint_service
Exemplo de respostas
Código de status: 200
O servidor processou a solicitação com sucesso.
{
"quotas" : {
"resources" : [ {
"type" : "endpoint",
"used" : 4,
"quota" : 150
}, {
"type" : "endpoint_service",
"used" : 10,
"quota" : 100
} ]
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
O servidor processou a solicitação com sucesso. |
|
400 |
A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada. |
|
401 |
A página solicitada requer um nome de usuário e senha. |
|
403 |
O servidor entendeu a solicitação, mas se recusa a atendê-la. |
|
404 |
A página solicitada não foi encontrada. |
|
405 |
O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação. |
|
406 |
O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação. |
|
407 |
O cliente deve primeiro autenticar-se com o proxy. |
|
408 |
O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar. |
|
409 |
A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso. |
|
500 |
Falhou ao concluir a solicitação. Anormalidade de serviço. |
|
501 |
Falhou ao concluir a solicitação. O servidor não suporta a função solicitada. |
|
502 |
Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida. |
|
503 |
Falhou ao concluir a solicitação. porque o sistema não está disponível. |
|
504 |
Gateway expirou o tempo limite |
Códigos de erro
Consulte Códigos de erro.