DescribeRateLimitPolicy - PolarDB: Central de Documentação do Alibaba Cloud

Consulta políticas de limite de taxa.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribeRateLimitPolicy

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-beijing
GwClusterId	string	Sim	O ID da instância do gateway.	pg-xxxxxxx
PolicyId	string	Não	O ID da política de limite de taxa.	02eccf7c61cf4d05a543075ee907f3**
ScopeType	string	Não	O escopo da política de limite de taxa. Valores válidos: ConsumerGroup: A política se aplica a um grupo de consumidores. Consumer: A política se aplica a um consumidor específico.	ConsumerGroup
ScopeRefId	string	Não	O ID do recurso de destino, que pode ser um grupo de consumidores ou um consumidor, dependendo do valor de `ScopeType`.	cg-xxxxxxxx
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 50 100. O valor padrão é 30.	30
PageNumber	integer	Não	O número da página a ser retornada. O valor padrão é 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID da solicitação.	CED079B7-A408-41A1-BFF1-EC608E******
TotalRecordCount	string	O número total de entradas correspondentes.	1
PageSize	string	O número de entradas retornadas por página.	30
PageNumber	string	O número da página retornada.	1
PageRecordCount	string	O número de entradas retornadas na página atual.	30
Items	array<object>	Um array de objetos de política de limite de taxa.
	object	Um objeto de política de limite de taxa.
PolicyId	string	O ID da política de limite de taxa.	02eccf7c61cf4d05a543075ee907f3**
GwClusterId	string	O ID da instância do gateway.	pg-xxxxxxxx
PolicyType	string	O tipo da política.	RateLimit
ScopeType	string	O escopo da política. Valores válidos: ConsumerGroup: A política se aplica a um grupo de consumidores. Consumer: A política se aplica a um consumidor específico.	ConsumerGroup
ScopeRefId	string	O ID do objeto dentro do escopo da política, como um grupo de consumidores ou um consumidor.	cg-xxxxxxx
RateLimitRpm	string	O máximo de solicitações por minuto (RPM).	10
RateLimitTpm	string	O máximo de tokens por minuto (TPM).	10
Status	string	O status da política. Valores válidos: Enabled: A política está ativada. Disabled: A política está desativada.	Enabled
GmtCreated	string	A hora de criação.	2025-12-01T17:52:05+08:00
GmtModified	string	A hora de modificação.	2026-01-19T16:47:25+08:00

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "TotalRecordCount": "1",
  "PageSize": "30",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "Items": [
    {
      "PolicyId": "02eccf7c61cf4d05a543075ee907f3**\n",
      "GwClusterId": "pg-xxxxxxxx",
      "PolicyType": "RateLimit",
      "ScopeType": "ConsumerGroup ",
      "ScopeRefId": "cg-xxxxxxx",
      "RateLimitRpm": "10",
      "RateLimitTpm": "10",
      "Status": "Enabled",
      "GmtCreated": "2025-12-01T17:52:05+08:00",
      "GmtModified": "2026-01-19T16:47:25+08:00"
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.