Consulta de configurações de limitação de solicitação excluídas
Função
Esta API é usada para consultar todas as configurações excluídas de uma política de limitação de solicitação.
URI
GET /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ções.  | 
     
| 
        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  | 
     
| 
        object_type  | 
      
        Não  | 
      
        String  | 
      
        Tipo de objeto, que pode ser APP ou USER.  | 
     
| 
        app_name  | 
      
        Não  | 
      
        String  | 
      
        Nome de uma aplicação excluída.  | 
     
| 
        user  | 
      
        Não  | 
      
        String  | 
      
        Nome de um usuário excluído.  | 
     
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.  | 
     
| 
        throttle_specials  | 
      
        Array of ThrottleSpecialInfo objects  | 
      
        Lista de configuração excluída.  | 
     
| 
        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ções.  | 
     
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
Nenhum
Exemplo de respostas
Código de status: 200
OK
{
  "total" : 1,
  "size" : 1,
  "throttle_specials" : [ {
    "call_limits" : 200,
    "app_name" : "app_demo",
    "object_name" : "app_demo",
    "object_id" : "356de8eb7a8742168586e5daf5339965",
    "throttle_id" : "3437448ad06f4e0c91a224183116e965",
    "apply_time" : "2020-08-04T02:40:56Z",
    "id" : "a3e9ff8db55544ed9db91d8b048770c0",
    "app_id" : "356de8eb7a8742168586e5daf5339965",
    "object_type" : "APP"
  } ]
}
  Código de status: 400
Solicitação inválida
{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_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: 404
Não encontrado
{
  "error_code" : "APIG.3005",
  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 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  | 
     
|---|---|
| 
        200  | 
      
        OK  | 
     
| 
        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.