ListProductQuotas - Quota Center: Central de Documentação do Alibaba Cloud

Consulta as cotas de um serviço de nuvem especificado.

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

quotas:ListProductQuotas

list

*Quota

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NextToken	string	Não	O token usado para recuperar a próxima página de resultados. Deixe este parâmetro vazio na primeira solicitação ou quando não houver mais resultados disponíveis. Se houver mais resultados disponíveis, defina este parâmetro com o valor NextToken retornado ao invocar a chamada de API anterior.	AAAAAd****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em uma única solicitação. Valores válidos: 1 a 100. Valor padrão: 30.	30
ProductCode	string	Sim	A abreviação do serviço de nuvem. Nota Para mais informações sobre como obter a abreviação de um serviço de nuvem, consulte ProductCode em ListProducts.	ecs
QuotaActionCode	string	Não	O ID da cota.	q_security-groups
KeyWord	string	Não	A palavra-chave de pesquisa para a cota. Nota Este parâmetro se aplica apenas às cotas de tipo de instância de servidor do Elastic Computing Service (ecs-spec). O escopo de pesquisa inclui QuotaName e QuotaActionCode.	security
SortField	string	Não	O método de classificação suportado pela cota. Nota Este parâmetro se aplica apenas às cotas de tipo de instância de servidor do Elastic Computing Service (ecs-spec). Se nenhuma configuração for especificada, ele será deixado vazio. Valores válidos: TOTAL : classificar por uso total da cota. TIME : classificar pela hora da última atualização. RESERVED : classificar por uso da cota reservada.	TIME
SortOrder	string	Não	O método de classificação suportado pela cota. Nota Este parâmetro se aplica apenas às cotas de tipo de instância de servidor do Elastic Computing Service (ecs-spec). Se nenhuma configuração for especificada, ele será deixado vazio. Valores válidos: Descending : ordem decrescente. Ascending : ordem crescente.	Ascending
Dimensions	array<object>	Não	As dimensões da cota.
	object	Não	As dimensões da cota.
Key	string	Não	A chave da dimensão da cota. Nota O intervalo de valores de N depende do número de dimensões suportadas pelo serviço de nuvem correspondente.	regionId
Value	string	Não	O valor da dimensão da cota. Nota O intervalo de valores de N depende do número de dimensões suportadas pelo serviço de nuvem correspondente.	cn-hangzhou
QuotaCategory	string	Não	A categoria da cota. Valor padrão: CommonQuota. Valores válidos: FlowControl : limite de taxa de API. WhiteListLabel : privilégio. CommonQuota : cota geral.	FlowControl
GroupCode	string	Não	O código do grupo de dimensões.	entconsole_w1j3ms****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
MaxResults	integer	O número máximo de registros retornados para a consulta atual.	1
NextToken	string	Indica se um token para a próxima consulta está disponível.\n\n- Se NextToken estiver vazio, indica que nenhuma consulta subsequente está disponível.\n- Se NextToken for retornado, o valor é o token usado para iniciar a próxima consulta.	AAAAAd****
Quotas	array<object>	Os detalhes da cota.
	array<object>	Os detalhes da cota.
Adjustable	boolean	Indica se a cota é ajustável. Valores válidos: true : A cota é ajustável. false : A cota não é ajustável.	true
ApplicableRange	array	O intervalo de valores de cota que pode ser aplicado para o item de cota atual, que serve como referência para solicitações de cota.
	number	O intervalo de valores de cota que pode ser aplicado para o item de cota atual.\n\nEste intervalo exclui o intervalo existente do usuário atual e serve como referência para solicitações de cota. Exemplo: `[1010,10000]`.	[1010,10000]
ApplicableType	string	O tipo de ajuste de cota. Valores válidos: continuous : Contínuo. discontinuous : Discontínuo.	discontinuous
ApplyReasonTips	string	Os motivos de exemplo para solicitar um ajuste de cota.	The business xxx is expected to grow by 50%.
Consumable	boolean	Indica se a cota utilizada é exibida. Valores válidos: true : A cota utilizada é exibida. false : A cota utilizada não é exibida.	true
Dimensions	object	As dimensões da cota. Formato: `{"regionId":"region"}`.	{"regionId":"cn-hangzhou"}
EffectiveTime	string	A hora UTC em que a cota entra em vigor.	2022-09-28T06:07:00Z
ExpireTime	string	A hora UTC em que a cota expira.	2022-09-29T06:07:00Z
GlobalQuota	boolean	Indica se a cota é uma cota global. Valores válidos: true : O item de cota é compartilhado em todas as regiões. false : O item de cota é independente para cada região.	true
Period	object	O período de cálculo da cota.
PeriodUnit	string	A unidade do período de cálculo da cota. Valores válidos: week : Semana. hour : Hora. day : Dia. second : Segundo. minute : Minuto.	day
PeriodValue	integer	O valor do período de cálculo da cota.	{}
ProductCode	string	A abreviação do nome do serviço de nuvem.	ecs
QuotaActionCode	string	O ID da cota.	q_security-groups
QuotaArn	string	O ARN da cota.	acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups
QuotaCategory	string	O tipo de cota. Valores válidos: FlowControl : limite de taxa de API. WhiteListLabel : privilégio. CommonQuota : cota geral.	CommonQuota
QuotaDescription	string	A descrição da cota.	The maximum number of security groups that can be owned by the current account.
QuotaItems	array<object>	Os detalhes da cota.
	object	Os detalhes da cota.
Quota	string	O valor da cota.	1009
QuotaUnit	string	A unidade da cota.	Count
Type	string	A categoria da cota. Valores válidos: BaseQuota : Cota base. ReservedQuota : Cota reservada.	BaseQuota
Usage	string	O uso da cota.	1009
QuotaName	string	O nome da cota.	ecs.g5.2xlarge
QuotaType	string	O tipo de cota. Valores válidos: normal : Normal. privilege : Privilégio.	privilege
QuotaUnit	string	A unidade da cota.	AMOUNT
SupportedRange	array	O intervalo de valores de cota suportado pelo item de cota atual, que serve como referência quando você configura um modelo de cota.
	number	O intervalo de valores de cota suportado pelo item de cota atual, que serve como referência quando você configura um modelo de cota.\n\n- Se ApplicableType for contínuo e o valor for [1009,10000], indica todos os números de 1009 a 10000.\n\n- Se ApplicableType for discontínuo e o valor for [10,20,50,100], indica apenas os valores 10, 20, 50 e 100.	[1009,10000]
TotalQuota	number	O valor da cota.	200
TotalUsage	number	O uso da cota.	1009
UnadjustableDetail	string	O motivo pelo qual a cota não é ajustável. Valores válidos: limitReached : O limite da cota foi atingido. nonactivated : O serviço não está ativado. applicationProcess : A solicitação de cota está sendo processada.	applicationProcess
UsageMetric	object	As informações de monitoramento do uso da cota no CloudMonitor.\n\n> Um valor vazio indica que não há dados de monitoramento disponíveis para esta cota no CloudMonitor.
MetricDimensions	object	As dimensões de monitoramento do CloudMonitor.\n\nFormato: uma coleção de pares `chave:valor`. Exemplo:\n`{"productCode":"*","metricKey":"","regionId":"","label":"*"}`.
	string	Os valores das dimensões de monitoramento do CloudMonitor.	ecs
MetricName	string	O nome da métrica de monitoramento do CloudMonitor.	Usage
MetricNamespace	string	O namespace dos dados de monitoramento do CloudMonitor.	acs_quotas_flowcontrol
RequestId	string	O ID da solicitação.	D0131FD5-5397-44FE-BF5A-4B7165B813CC
TotalCount	integer	O número total de registros retornados para a solicitação atual.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "MaxResults": 1,
  "NextToken": "AAAAAd****",
  "Quotas": [
    {
      "Adjustable": true,
      "ApplicableRange": [
        0
      ],
      "ApplicableType": "discontinuous",
      "ApplyReasonTips": "The business xxx is expected to grow by 50%.",
      "Consumable": true,
      "Dimensions": {
        "regionId": "cn-hangzhou"
      },
      "EffectiveTime": "2022-09-28T06:07:00Z",
      "ExpireTime": "2022-09-29T06:07:00Z",
      "GlobalQuota": true,
      "Period": {
        "PeriodUnit": "day",
        "PeriodValue": 0
      },
      "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": "1009",
          "QuotaUnit": "Count",
          "Type": "BaseQuota",
          "Usage": "1009"
        }
      ],
      "QuotaName": "ecs.g5.2xlarge",
      "QuotaType": "privilege",
      "QuotaUnit": "AMOUNT",
      "SupportedRange": [
        0
      ],
      "TotalQuota": 200,
      "TotalUsage": 1009,
      "UnadjustableDetail": "applicationProcess",
      "UsageMetric": {
        "MetricDimensions": {
          "key": "ecs"
        },
        "MetricName": "Usage",
        "MetricNamespace": "acs_quotas_flowcontrol"
      }
    }
  ],
  "RequestId": "D0131FD5-5397-44FE-BF5A-4B7165B813CC",
  "TotalCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidSortOrder	Invalid SortOrder
400	INVALID.MAX.RESULTS	The maxResults parameter is invalid. Use an integer ranging from 1 to 100.
400	DIMENSIONGROUP.NOT.FOUND	Dimension group does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.