DescribeRateLimitPolicy - PolarDB - Centro de documentación de Alibaba Cloud

Consulta las políticas de límite de velocidad.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeRateLimitPolicy

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región.	cn-beijing
GwClusterId	string	Sí	El ID de la instancia de puerta de enlace.	pg-xxxxxxx
PolicyId	string	No	El ID de la política de límite de velocidad.	02eccf7c61cf4d05a543075ee907f3**
ScopeType	string	No	El alcance de la política de límite de velocidad. Valores válidos: ConsumerGroup: La política se aplica a un grupo de consumidores. Consumer: La política se aplica a un consumidor específico.	ConsumerGroup
ScopeRefId	string	No	El ID del recurso de destino, que puede ser un grupo de consumidores o un consumidor, según el valor de `ScopeType`.	cg-xxxxxxxx
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100. El valor predeterminado es 30.	30
PageNumber	integer	No	El número de página a devolver. El valor predeterminado es 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El objeto de respuesta.
RequestId	string	El ID de la solicitud.	CED079B7-A408-41A1-BFF1-EC608E******
TotalRecordCount	string	El número total de entradas coincidentes.	1
PageSize	string	El número de entradas devueltas por página.	30
PageNumber	string	El número de página devuelto.	1
PageRecordCount	string	El número de entradas devueltas en la página actual.	30
Items	array<object>	Una matriz de objetos de política de límite de velocidad.
	object	Un objeto de política de límite de velocidad.
PolicyId	string	El ID de la política de límite de velocidad.	02eccf7c61cf4d05a543075ee907f3**
GwClusterId	string	El ID de la instancia de puerta de enlace.	pg-xxxxxxxx
PolicyType	string	El tipo de política.	RateLimit
ScopeType	string	El alcance de la política. Valores válidos: ConsumerGroup: La política se aplica a un grupo de consumidores. Consumer: La política se aplica a un consumidor específico.	ConsumerGroup
ScopeRefId	string	El ID del objeto dentro del alcance de la política, como un grupo de consumidores o un consumidor.	cg-xxxxxxx
RateLimitRpm	string	El máximo de solicitudes por minuto (RPM).	10
RateLimitTpm	string	El máximo de tokens por minuto (TPM).	10
Status	string	El estado de la política. Valores válidos: Enabled: La política está habilitada. Disabled: La política está deshabilitada.	Enabled
GmtCreated	string	La hora de creación.	2025-12-01T17:52:05+08:00
GmtModified	string	La hora de modificación.	2026-01-19T16:47:25+08:00

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.