Criação de uma configuração de limitação de solicitação excluída
Função
Uma política de limitação de solicitações controla o número máximo de vezes que uma API pode ser acessada em um período especificado e o número máximo de vezes que a API pode ser acessada por um locatário ou uma aplicação no mesmo período.
Se necessário, você pode criar uma configuração de limitação de solicitações excluída para especificar o limite de chamadas de API para uma aplicação específica. Por exemplo, se você definir o limite de chamada de API para todos as aplicações como 500 chamadas/minuto, poderá especificar o limite de chamada de API da aplicação 1 como 800 chamadas/minuto.
Você pode adicionar aplicações ou locatários excluídos a uma política de limitação de solicitações.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
|
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. |
|
throttle_id |
Sim |
String |
ID da política de limitação de solicitação. |
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 |
|---|---|---|---|
|
call_limits |
Sim |
Integer |
Número máximo de vezes que um objeto excluído pode acessar uma API dentro do período de limitação. |
|
object_id |
Sim |
String |
ID da aplicação excluída ou ID da conta excluída. |
|
object_type |
Sim |
String |
Tipo de objeto excluído. Valores de enumeração:
|
Parâmetros de resposta
Código de status: 201
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID de configuração excluída. |
|
call_limits |
Integer |
Número máximo de vezes que um objeto excluído pode acessar uma API dentro do período de limitação. |
|
apply_time |
String |
Período de limitação. |
|
app_name |
String |
Nome de aplicação. |
|
app_id |
String |
ID de aplicação. |
|
object_id |
String |
ID de um objeto especificado na configuração excluída. |
|
object_type |
String |
Tipo de objeto excluído, que pode ser APP ou USER. |
|
object_name |
String |
Nome de uma aplicação ou de um locatário ao qual a configuração excluída se aplica. |
|
throttle_id |
String |
ID da política de limitação de solicitação. |
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
{
"call_limits" : 150,
"object_id" : "356de8eb7a8742168586e5daf5339965",
"object_type" : "APP"
}
Exemplo de respostas
Código de status: 201
Criado
{
"call_limits" : 150,
"app_name" : "app_demo",
"object_name" : "app_demo",
"object_id" : "356de8eb7a8742168586e5daf5339965",
"throttle_id" : "3437448ad06f4e0c91a224183116e965",
"apply_time" : "2020-08-04T02:40:56.717710961Z",
"id" : "a3e9ff8db55544ed9db91d8b048770c0",
"app_id" : "356de8eb7a8742168586e5daf5339965",
"object_type" : "APP"
}
Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2003",
"error_msg" : "The parameter value is too large,parameterName:call_limits. 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.3004",
"error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}
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.
