GetProductQuota - Quota Center - Centro de documentación de Alibaba Cloud

Consulta los detalles de una cuota para un producto de Alibaba Cloud especificado.

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

quotas:GetProductQuota

get

*Quota

acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProductCode	string	Sí	La abreviatura del nombre del producto de Alibaba Cloud. Nota Para obtener más información, consulte el parámetro ProductCode en ListProducts.	ecs
QuotaActionCode	string	Sí	El ID de la cuota. Nota Para obtener más información, consulte el parámetro QuotaActionCode en ListProductQuotas.	q_security-groups
Dimensions	array<object>	No	Las dimensiones de la cuota. Una dimensión de cuota es una propiedad de una cuota. La combinación de Dimensions y QuotaActionCode identifica de forma única una cuota. Nota Las dimensiones son obligatorias para algunos productos de Alibaba Cloud. Puede llamar a la operación ListProductQuotaDimensions para consultar las dimensiones de una cuota y verificar si son obligatorias. El parámetro Requisite en la respuesta indica si una dimensión es obligatoria.	{\"regionId\":\"cn-beijing\"}
	object	No	Las dimensiones de la cuota.
Key	string	No	La clave de la dimensión de la cuota. Nota Dimensions.N.Key y Dimensions.N.Value deben especificarse al mismo tiempo. El valor de N está determinado por el número de dimensiones que admite el producto de Alibaba Cloud. Puede llamar a la operación ListProductQuotaDimensions para consultar las dimensiones admitidas. El valor de N es la longitud del arreglo devuelto.	regionId
Value	string	No	El valor de la dimensión de la cuota. Nota Dimensions.N.Key y Dimensions.N.Value deben especificarse al mismo tiempo. El valor de N está determinado por el número de dimensiones que admite el producto de Alibaba Cloud. Puede llamar a la operación ListProductQuotaDimensions para consultar las dimensiones admitidas. El valor de N es la longitud del arreglo devuelto.	cn-hangzhou

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
Quota	object	Los detalles de la cuota.
Adjustable	boolean	Indica si la cuota es ajustable. Valores válidos: true: La cuota es ajustable. false: La cuota no es ajustable.	true
ApplicableRange	array	El rango ajustable de la cuota.
	number	El rango ajustable de la cuota. Por ejemplo: `[802,10000]`.	802
ApplicableType	string	El tipo de la cuota ajustable. Valores válidos: continuous: El valor de la cuota es continuo. discontinuous: El valor de la cuota es discontinuo.	continuous
ApplyReasonTips	string	Un ejemplo del motivo para una solicitud de aumento de cuota.	Se espera que el negocio xxx crezca un 50%
Consumable	boolean	Indica si se muestra la cuota utilizada. Valores válidos: true: Se muestra la cuota utilizada. false: No se muestra la cuota utilizada.	true
Dimensions	object	Las dimensiones de la cuota. Formato: `{"regionId":"El ID de la región"}`.	{"regionId":"cn-hangzhou"}
EffectiveTime	string	La hora UTC en la que entra en vigor la cuota.	2022-09-28T06:06:00Z
ExpireTime	string	La hora UTC en la que caduca la cuota.	2022-09-29T06:06:00Z
GlobalQuota	boolean	Indica si la cuota es una cuota global. Valores válidos: true: La cuota se comparte en todas las regiones. false: La cuota es independiente para cada región.	true
Period	object	El periodo de cálculo de la cuota.
PeriodUnit	string	La unidad del periodo de cálculo. Valores válidos: second minute hour day week	day
PeriodValue	integer	El valor del periodo de cálculo.	1
ProductCode	string	La abreviatura del nombre del producto de Alibaba Cloud.	ecs
QuotaActionCode	string	El ID de la cuota.	q_security-groups
QuotaArn	string	El nombre de recurso de Alibaba Cloud (ARN) de la cuota.	acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/
QuotaCategory	string	La categoría de la cuota. Valores válidos: CommonQuota: cuota general. FlowControl: límite de velocidad de API. WhiteListLabel: privilegio.	CommonQuota
QuotaDescription	string	La descripción de la cuota.	El número máximo de security groups que puede tener la cuenta actual
QuotaItems	array<object>	Los detalles de la cuota.
	object	El tipo de cuota.
Quota	string	The quota value.	801
QuotaUnit	string	La unidad de la cuota. Nota Las unidades de las cuotas varían. Por ejemplo, la unidad de la cuota `q_cbdch3`, que representa el número máximo de clústeres para Container Service for Kubernetes (ACK), es Cluster. La unidad de la cuota `q_security-groups`, que representa el número máximo de security groups para Elastic Compute Service (ECS), es Count.	Count
Type	string	El tipo de cuota. Valores válidos: BaseQuota ReservedQuota	BaseQuota
Usage	string	La cuota utilizada.	26
QuotaName	string	El nombre de la cuota.	Número máximo de security groups
QuotaType	string	El tipo de la cuota. Valores válidos: privilege normal	normal
QuotaUnit	string	La unidad de la cuota. Nota Las unidades de las cuotas varían. Por ejemplo, la unidad de la cuota `q_cbdch3`, que representa el número máximo de clústeres para Container Service for Kubernetes (ACK), es Cluster. La unidad de la cuota `q_security-groups`, que representa el número máximo de security groups para Elastic Compute Service (ECS), es Count.	Count
SupportedRange	array	El rango de valores de cuota que admite la cuota. Puede consultar este rango cuando configure una plantilla de cuotas.
	number	El rango de valores de cuota que admite la cuota. Puede consultar este rango cuando configure una plantilla de cuotas. Si ApplicableType se establece en continuous y el valor de este parámetro es [802,1000], el valor de la cuota puede ser cualquier número entero de 802 a 1000. Si ApplicableType se establece en discontinuous y el valor de este parámetro es [10,20,50,100], el valor de la cuota puede ser 10, 20, 50 o 100.	[802,1000]
TotalQuota	number	El valor de la cuota.	801
TotalUsage	number	La cuota utilizada.	26
UnadjustableDetail	string	El motivo por el cual la cuota no es ajustable. Valores válidos: nonactivated: El servicio no está activado. applicationProcess: La solicitud de aumento de cuota se está procesando. limitReached: Se ha alcanzado el límite de la cuota. supportTicketRequired: Debe enviar un ticket para solicitar un aumento de cuota.	limitReached
UsageMetric	object	La información sobre el monitoreo del uso de la cuota en CloudMonitor. Nota Si este parámetro está vacío, no hay datos de monitoreo disponibles en CloudMonitor.
MetricDimensions	object	Las dimensiones para monitorear el uso de la cuota en CloudMonitor. Formato: una colección de pares clave-valor. Por ejemplo: `{"productCode":"*","metricKey":"","regionId":"","label":"*"}`.
	string	El valor de una dimensión para monitorear el uso de la cuota en CloudMonitor.	ecs
MetricName	string	El nombre de la métrica para monitorear el uso de la cuota en CloudMonitor.	Usage
MetricNamespace	string	El espacio de nombres de la métrica para monitorear el uso de la cuota en CloudMonitor.	acs_quotas_flowcontrol
RequestId	string	El ID de la solicitud.	8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Quota": {
    "Adjustable": true,
    "ApplicableRange": [
      802
    ],
    "ApplicableType": "continuous",
    "ApplyReasonTips": "The business xxx is expected to grow by 50%.",
    "Consumable": true,
    "Dimensions": {
      "regionId": "cn-hangzhou"
    },
    "EffectiveTime": "2022-09-28T06:06:00Z",
    "ExpireTime": "2022-09-29T06:06:00Z",
    "GlobalQuota": true,
    "Period": {
      "PeriodUnit": "day",
      "PeriodValue": 1
    },
    "ProductCode": "ecs",
    "QuotaActionCode": "q_security-groups",
    "QuotaArn": "acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/",
    "QuotaCategory": "CommonQuota",
    "QuotaDescription": "The maximum number of security groups that can be owned by the current account.",
    "QuotaItems": [
      {
        "Quota": "801",
        "QuotaUnit": "Count",
        "Type": "BaseQuota",
        "Usage": "26"
      }
    ],
    "QuotaName": "Maximum Number of Security Groups",
    "QuotaType": "normal",
    "QuotaUnit": "Count",
    "SupportedRange": [
      0
    ],
    "TotalQuota": 801,
    "TotalUsage": 26,
    "UnadjustableDetail": "limitReached",
    "UsageMetric": {
      "MetricDimensions": {
        "key": "ecs"
      },
      "MetricName": "Usage",
      "MetricNamespace": "acs_quotas_flowcontrol"
    }
  },
  "RequestId": "8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3"
}

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.