GetQuota - MaxCompute: Central de Documentação do Alibaba Cloud

Obtém informações do grupo de cotas de nível 1 especificado. Aviso: esta operação será descontinuada em 31 de julho de 2024. Ela será substituída pela operação QueryQuota. Os parâmetros de solicitação, os parâmetros de resposta e os recursos das duas operações são os mesmos.

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

odps:GetQuota

get

*Quota

acs:odps:{#regionId}:{#accountId}:quotas/{#NickName}

Nenhuma

Sintaxe da solicitação

GET /api/v1/quotas/{nickname} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
nickname	string	Sim	O nome da cota.	%E9%BB%98%E8%AE%A4%E9%A2%84%E4%BB%98%E8%B4%B9Quota_p # Chinese name needs to be UTF-8 URL-encoded

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
tenantId `deprecated`	string	Não
region `deprecated`	string	Não
AkProven `deprecated`	string	Não
mock	boolean	Não	Especifica se deve incluir submódulos. Valores válidos: - true: inclui submódulos. - false (padrão): não inclui submódulos.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	PopCompatibleResult.
billingPolicy	object	As informações do pedido.
billingMethod	string	O método de cobrança. subscription: indica uma cota por assinatura. payasyougo: indica uma cota pay-as-you-go.	subscription
odpsSpecCode	string	As especificações do pedido.	OdpsStandard
orderId	string	O ID do pedido.	45245678
saleTag	object	O identificador do objeto de cota do MaxCompute. Este identificador é o mesmo que o identificador na fatura da Alibaba Cloud. Este parâmetro é usado em cenários de tags.
resourceIds	array	O identificador do objeto de cota do MaxCompute. Este identificador também existe no subsistema de cobrança da Alibaba Cloud. Você pode usar este identificador para associar os custos de um objeto de cota a uma tag.
	string	O identificador do objeto de cota do MaxCompute. Este identificador também existe no subsistema de cobrança da Alibaba Cloud. Você pode usar este identificador para associar os custos de um objeto de cota a uma tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	O tipo do objeto. Atualmente, apenas cota e projeto são suportados.	"quota"
cluster	string	O ID do cluster.	AT-120N
createTime	integer	A hora em que o recurso foi criado.	2022-09-06T02:14:44Z
creatorId	string	O criador do recurso. Este parâmetro é o UID de uma conta da Alibaba Cloud.	672863518
requestId	string	O ID da solicitação.	0b87b7a316654730544735643e9200
id	string	O ID da cota.	0
name	string	O nome da cota.	quota_a
nickName	string	O alias da cota.	quota_nickname
parameter	object	A descrição da cota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
parentId	string	O ID do recurso pai.	null
regionId	string	O ID da região.	cn-beijing
scheduleInfo	object	As informações de compartilhamento de tempo.
currPlan	string	O plano de cota que está em vigor com base no plano de agendamento.	planA
currTime	string	A hora em que o currPlan foi agendado.	0800
nextPlan	string	O plano de cota que está prestes a entrar em vigor com base no plano de agendamento.	planB
nextTime	string	A hora em que o next_plan está agendado.	1700
oncePlan	string	O plano de cota que entra em vigor imediatamente. Este parâmetro não está vazio se um usuário acionar um plano diferente do curr_plan para entrar em vigor imediatamente.	planC
onceTime	string	A hora em que o plano de efeito imediato foi acionado.	1500
operatorName	string	O nome do operador.	userA
timezone	string	O fuso horário.	UTC+8
status	string	O status do recurso.	ON
subQuotaInfoList	array<object>	As informações sobre as cotas de nível 2.
	array<object>	Os dados.
billingPolicy	object	As informações do pedido.
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
saleTag	object	O identificador do objeto de cota do MaxCompute. Este identificador é o mesmo que o identificador na fatura da Alibaba Cloud. Este parâmetro é usado em cenários de tags.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
cluster	string	O ID do cluster.	AT-120N
createTime	integer	A hora em que o recurso foi criado.	2022-09-06T02:14:44Z
creatorId	string	O criador do recurso. Este parâmetro é o UID de uma conta da Alibaba Cloud.	672863518
id	string	O ID da cota de nível 2.	1000048
name	string	O nome da cota de nível 2.	subquotaA
nickName	string	O alias da cota de nível 2.	subquotaA
parameter	object	A descrição da cota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
enablePriority	boolean	Enables the priority feature.	true
forceReservedMin	boolean	Specifies whether to enable exclusive use.	true
maxCU	integer	The upper limit of reserved computing units (CUs).	50
minCU	integer	The guaranteed reserved CUs.	50
schedulerType	string	The scheduling policy.	Fifo/Fair
singleJobCULimit	integer	The upper limit of CUs for a single job.	10
elasticReservedCU	integer	The value of elastic reserved CUs.	50
parentId	string	O ID do recurso pai.	0
regionId	string	O ID da região.	cn-beijing
scheduleInfo	object	As informações de compartilhamento de tempo.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	planC
onceTime	string	The time when the immediate-effect plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
status	string	O status do recurso.	ON
tag	string	A tag de recurso da cota.	abc
tenantId	string	O ID do tenant.	478403690625249
type	string	Este parâmetro corresponde ao campo resourceSystemType do cluster de controle.	FUXI_ONLINE
version	string	O número da versão.	1
tag	string	A tag de recurso da cota.	abc
tenantId	string	O ID do tenant.	478403690625249
type	string	Este parâmetro corresponde ao campo resourceSystemType do cluster de controle.	FUXI_ONLINE
version	string	O número da versão.	1
data	object	Os dados retornados.
id	string	O ID da cota.	0
name	string	O nome da cota.	quota_a
nickName	string	O alias da cota.	quota_nickname
type	string	Este parâmetro corresponde ao campo resourceSystemType do cluster de controle.	FUXI_ONLINE
status	string	O status do recurso.	ON
saleTag	object	O identificador do objeto de cota do MaxCompute. Este identificador é o mesmo que o identificador na fatura da Alibaba Cloud. Este parâmetro é usado em cenários de tags.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
tenantId	string	O ID do tenant.	478403690625249
regionId	string	O ID da região.	cn-beijing
parentId	string	O ID do recurso pai.	null
cluster	string	O ID do cluster.	AT-120N
version	string	O número da versão.	1
billingPolicy	object	As informações do pedido.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
scheduleInfo	object	As informações de compartilhamento de tempo.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	planC
onceTime	string	The time when the immediate-effect plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
parameter	object	A descrição da cota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
tag	string	A tag de recurso da cota.	abc
createTime	integer	A hora em que o recurso foi criado.	2022-09-06T02:14:44Z
creatorId	string	O criador do recurso. Este parâmetro é o UID de uma conta da Alibaba Cloud.	672863518
subQuotaInfoList	array<object>	As informações sobre as cotas de nível 2.
	array<object>	Os dados.
id	string	The level-2 quota ID.	1000048
name	string	The name of the level-2 quota.	subquotaA
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the identifier in the bill of Alibaba Cloud. This parameter is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
nickName	string	The nickname of the level-2 quota.	subquotaA
type	string	This parameter corresponds to the resourceSystemType field of the control cluster.	FUXI_ONLINE
status	string	The resource status.	ON
tenantId	string	The tenant ID.	478403690625249
regionId	string	The region ID.	cn-beijing
parentId	string	The ID of the parent resource.	0
cluster	string	The cluster ID.	AT-120N
version	string	The version number.	1
billingPolicy	object	The order information.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
scheduleInfo	object	The time-sharing information.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	planC
onceTime	string	The time when the immediate-effect plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
parameter	object	The description of the quota.
enablePriority	boolean	Enables the priority feature.	true
forceReservedMin	boolean	Specifies whether to enable exclusive use.	true
maxCU	integer	The upper limit of reserved computing units (CUs).	50
minCU	integer	The guaranteed reserved CUs.	50
schedulerType	string	The scheduling policy.	Fifo/Fair
singleJobCULimit	integer	The upper limit of CUs for a single job.	10
elasticReservedCU	integer	The value of elastic reserved CUs.	50
tag	string	The resource tag of the quota.	abc
createTime	integer	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The creator of the resource. This parameter is the UID of an Alibaba Cloud account.	672863518

Exemplos

Resposta de sucesso

JSON formato

{
  "billingPolicy": {
    "billingMethod": "subscription\n",
    "odpsSpecCode": "OdpsStandard",
    "orderId": "45245678"
  },
  "saleTag": {
    "resourceIds": [
      "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
    ],
    "resourceType": "\"quota\""
  },
  "cluster": "AT-120N",
  "createTime": 0,
  "creatorId": "672863518\n",
  "requestId": "0b87b7a316654730544735643e9200",
  "id": "0",
  "name": "quota_a\n",
  "nickName": "quota_nickname",
  "parameter": {
    "test": "test",
    "test2": 1
  },
  "parentId": "null",
  "regionId": "cn-beijing",
  "scheduleInfo": {
    "currPlan": "planA",
    "currTime": "0800",
    "nextPlan": "planB",
    "nextTime": "1700",
    "oncePlan": "planC",
    "onceTime": "1500",
    "operatorName": "userA",
    "timezone": "UTC+8"
  },
  "status": "ON",
  "subQuotaInfoList": [
    {
      "billingPolicy": {
        "billingMethod": "subscription",
        "odpsSpecCode": "OdpsStandard\n",
        "orderId": "45245678\n"
      },
      "saleTag": {
        "resourceIds": [
          "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
        ],
        "resourceType": "\"quota\""
      },
      "cluster": "AT-120N\n",
      "createTime": 0,
      "creatorId": "672863518\n",
      "id": "1000048\n",
      "name": "subquotaA\n",
      "nickName": "subquotaA\n",
      "parameter": {
        "enablePriority": true,
        "forceReservedMin": true,
        "maxCU": 50,
        "minCU": 50,
        "schedulerType": "Fifo/Fair",
        "singleJobCULimit": 10,
        "elasticReservedCU": 50
      },
      "parentId": "0",
      "regionId": "cn-beijing",
      "scheduleInfo": {
        "currPlan": "planA",
        "currTime": "0800",
        "nextPlan": "planB",
        "nextTime": "1700",
        "oncePlan": "planC",
        "onceTime": "1500",
        "operatorName": "userA\n",
        "timezone": "UTC+8"
      },
      "status": "ON\n",
      "tag": "abc",
      "tenantId": "478403690625249",
      "type": "FUXI_ONLINE",
      "version": "1"
    }
  ],
  "tag": "abc",
  "tenantId": "478403690625249",
  "type": "FUXI_ONLINE",
  "version": "1",
  "data": {
    "id": "0",
    "name": "quota_a",
    "nickName": "quota_nickname",
    "type": "FUXI_ONLINE",
    "status": "ON",
    "saleTag": {
      "resourceIds": [
        "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
      ],
      "resourceType": "\"quota\"\n"
    },
    "tenantId": "478403690625249",
    "regionId": "cn-beijing",
    "parentId": "null",
    "cluster": "AT-120N",
    "version": "1",
    "billingPolicy": {
      "odpsSpecCode": "OdpsStandard",
      "orderId": "45245678",
      "billingMethod": "subscription"
    },
    "scheduleInfo": {
      "currPlan": "planA",
      "currTime": "0800",
      "nextPlan": "planB",
      "nextTime": "1700",
      "oncePlan": "planC",
      "onceTime": "1500",
      "operatorName": "userA",
      "timezone": "UTC+8"
    },
    "parameter": {
      "test": "test",
      "test2": 1
    },
    "tag": "abc",
    "createTime": 0,
    "creatorId": "672863518",
    "subQuotaInfoList": [
      {
        "id": "1000048",
        "name": "subquotaA",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        },
        "nickName": "subquotaA",
        "type": "FUXI_ONLINE",
        "status": "ON",
        "tenantId": "478403690625249\n",
        "regionId": "cn-beijing",
        "parentId": "0",
        "cluster": "AT-120N\n",
        "version": "1",
        "billingPolicy": {
          "odpsSpecCode": "OdpsStandard",
          "orderId": "45245678",
          "billingMethod": "subscription"
        },
        "scheduleInfo": {
          "currPlan": "planA",
          "currTime": "0800",
          "nextPlan": "planB",
          "nextTime": "1700",
          "oncePlan": "planC",
          "onceTime": "1500",
          "operatorName": "userA",
          "timezone": "UTC+8"
        },
        "parameter": {
          "enablePriority": true,
          "forceReservedMin": true,
          "maxCU": 50,
          "minCU": 50,
          "schedulerType": "Fifo/Fair\n",
          "singleJobCULimit": 10,
          "elasticReservedCU": 50
        },
        "tag": "abc",
        "createTime": 0,
        "creatorId": "672863518"
      }
    ]
  }
}

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.