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

Consulta las políticas de presupuesto de costos.

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:DescribeBudgetPolicies

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BudgetPolicyId	string	No	El ID de la política de presupuesto.	023aacc1effc4b56bb154bfbec6baxxx
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
PageNumber	integer	No	El número de página.	1
GwClusterId	string	Sí	El ID de la instancia de gateway.	pg-xxxxxxx
Status	string	No	El estado de la política. Valores válidos: Enabled: habilitado Disenabled: deshabilitado	Enabled
BudgetDimensionType	string	No	El tipo de política. Valores válidos: ConsumerGroup: presupuesto total para un grupo de usuarios Consumer: presupuesto total para un usuario	ConsumerGroup
BudgetDimensionRefId	string	No	El ID del objeto de dimensión. Este parámetro es obligatorio cuando BudgetDimensionType se establece en ConsumerGroup o Consumer.	cg-p3gk2oh55c**
RegionId	string	No	El ID de la región.	cn-beijing
ScopeRefName	string	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	24A1990B-4F6E-482B-B8CB-75C612******
TotalRecordCount	integer	El número total de registros.	2
PageRecordCount	integer	El número de registros en la página actual.	1
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valores válidos: 30, 50 y 100. Valor predeterminado: 30.	30
Items	array<object>	La lista de políticas de presupuesto.
	object	El objeto de política de presupuesto.
BudgetPolicyId	string	El ID de la política de presupuesto.	023aacc1effc4b56bb154bfbec6ba9**
GwClusterId	string	El ID de la instancia de gateway.	pg-xxxxxxxx
Status	string	El estado de la política. Valores válidos: Enabled: habilitado Disenabled: deshabilitado	Enabled
BudgetType	string	El tipo de presupuesto. Valores válidos: GlobalTotal: presupuesto total global ConsumerTotal: presupuesto total para un usuario ConsumerGroupTotal: presupuesto total para un grupo de usuarios	GlobalTotal
BudgetDimensionType	string	El tipo de política. Valores válidos: ConsumerGroup: presupuesto total para un grupo de usuarios Consumer: presupuesto total para un usuario	ConsumerGroup
BudgetDimensionRefId	string	El ID del objeto de dimensión. Este parámetro es obligatorio cuando BudgetDimensionType se establece en ConsumerGroup o Consumer.	cg-p3gk2oh55c**
ResetDayOfMonth	string	El día del mes en que se restablece el presupuesto. Valores válidos: 1 a 28.	2
BudgetPoints	string	Los puntos de presupuesto.	10000
AlertThresholdPct	string	El porcentaje de umbral de alerta. Valores válidos: 0 a 100.	80
UsedPoints	integer	El número de puntos utilizados.	10
GmtCreated	string	La hora en que se creó la política.	2025-03-19T14:13:53+08:00
GmtModified	string	La hora en que se modificó la política por última vez.	2025-04-08T10:43:28+08:00
AlertTriggered	boolean	Indica si se ha activado el umbral de alerta.	false
Exceeded	string	Indica si se ha excedido la cuota.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "TotalRecordCount": 2,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "BudgetPolicyId": "023aacc1effc4b56bb154bfbec6ba9**",
      "GwClusterId": "pg-xxxxxxxx",
      "Status": "Enabled",
      "BudgetType": "GlobalTotal",
      "BudgetDimensionType": "ConsumerGroup ",
      "BudgetDimensionRefId": "cg-p3gk2oh55c**",
      "ResetDayOfMonth": "2",
      "BudgetPoints": "10000",
      "AlertThresholdPct": "80",
      "UsedPoints": 10,
      "GmtCreated": "2025-03-19T14:13:53+08:00",
      "GmtModified": "2025-04-08T10:43:28+08:00",
      "AlertTriggered": false,
      "Exceeded": "false"
    }
  ]
}

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.