All Products
Search
Document Center

Quota Center:CreateQuotaApplication

Last Updated:Nov 14, 2024

Submits an application to increase a quota.

Operation description

In this example, the operation is called to submit an application to increase the value of a quota whose ID is q_security-groups and whose name is Maximum Number of Security Groups. The quota belongs to Elastic Compute Service (ECS). The expected value of the quota is 804, the application reason is Scale Out, and the ID of the region to which the quota belongs is cn-hangzhou.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quotas:CreateQuotaApplicationcreate
  • QuotaApplication
    acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The abbreviation of the Alibaba Cloud service name.

Note To query the abbreviation of an Alibaba Cloud service name, check the ProductCode parameter that is described in ListProductQuotas .
ecs
QuotaActionCodestringYes

The quota ID.

Note To query the quota ID of an Alibaba Cloud service, check the QuotaActionCode parameter that is described in ListProductQuotas .
q_security-groups
DesireValuefloatYes

The requested value of the quota.

Note
  • You can specify the DesireValue parameter based on the values of the TotalUsage and ApplicableRange parameters that are returned by the ListProductQuotas operation.

  • Applications are reviewed by the technical support team of each Alibaba Cloud service. To increase the success rate of your application, you must specify a reasonable quota value and detailed reasons when you submit an application to increase the value of the quota.

804
ReasonstringYes

The reason for the application.

Note Applications are reviewed by the technical support team of each Alibaba Cloud service. To increase the success rate of your application, you must specify a reasonable quota value and detailed reasons when you submit an application to increase the value of the quota.
Scale Out
NoticeTypeintegerNo

Specifies whether to send a notification about the application result. Valid values:

  • 0 (default value): sends a notification about the application result.
  • 3: A notification about the application result is sent.
0
Dimensionsarray<object>No

The quota dimensions. A quota item is uniquely determined by the values of Dimensions and QuotaActionCode.

Note Some dimensions are required. You can call the ListProductQuotaDimensions operation to query the quota dimensions that are supported by an Alibaba Cloud service. The value of Requisite in the response indicates whether a dimension is required.
objectNo

The quota dimension.

KeystringNo

The key of the dimension.

Note You must configure Dimensions.N.Key and Dimensions.N.Value at the same time. The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service. You can call the ListProductQuotaDimensions operation to query the dimensions that are supported by an Alibaba Cloud service. The number of elements in the returned array is N.
regionId
ValuestringNo

The value of the dimension.

Note You must configure Dimensions.N.Key and Dimensions.N.Value at the same time. The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service. You can call the ListProductQuotaDimensions operation to query the dimensions that are supported by an Alibaba Cloud service. The number of elements in the returned array is N.
cn-hangzhou
QuotaCategorystringNo

The type of the quota. Valid values:

Default value: CommonQuota.

Valid values:

  • FlowControl: API rate limit
  • WhiteListLabel: whitelist quota
  • CommonQuota: general quota
CommonQuota
AuditModestringNo
Note This parameter is discontinued and is not recommended.

The mode in which you want the application to be reviewed.

Valid values:

  • Sync: The application is reviewed in a synchronous manner. Quota Center automatically reviews the application. The result is returned immediately after you submit the application. However, the chance of an approval for an application that is reviewed in Sync mode is lower than the chance of an approval for an application that is reviewed in Async mode. The validity period of the new quota value is 1 hour.
  • Async: The application is reviewed in an asynchronous manner. An Alibaba Cloud support engineer reviews the application. The chance of an approval for an application that is reviewed in Async mode is higher than the chance of an approval for an application that is reviewed in Sync mode. The validity period of the new quota value is one month.
Sync
EnvLanguagestringNo

The language of the quota alert notification.

Valid values:

  • en: English
  • zh: Chinese
zh
ExpireTimestringNo

The start time of the validity period of the quota. Specify the value in UTC. This parameter is valid only if you set the QuotaCategory parameter to WhiteListLabel.

Note If you do not specify a start time, the default start time is the time when the quota application is submitted.
2021-01-20T09:25:56Z
EffectiveTimestringNo

The end time of the validity period of the quota. Specify the value in UTC. This parameter is valid only if you set the QuotaCategory parameter to WhiteListLabel.

Note If you do not specify an end time, the default end time is 99 years after the quota application is submitted.
2021-01-19T09:25:56Z

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ApplicationIdstring

The ID of the application.

d314d6ae-867d-484c-9009-3d421a80****
ApplyTimestring

The time when the application was submitted.

2021-01-19T09:25:56Z
ApproveValuefloat

The quota value that is approved.

804
AuditReasonstring

The result of the application.

Agree
DesireValueinteger

The requested value of the quota.

12
Dimensionobject

The quota dimension.

{"regionId":"cn-hangzhou"}
EffectiveTimestring

The time when the new quota value takes effect.

2021-01-19T09:25:56Z
ExpireTimestring

The time when the new quota expires.

2021-01-20T09:25:56Z
NoticeTypelong

Indicates whether the notification about the application result is sent. Valid values:

  • 0: The notification is not sent.
  • 3: The notification is sent.
3
ProductCodestring

The abbreviation of the Alibaba Cloud service name.

ecs-spec
QuotaActionCodestring

The quota ID.

ecs.c5.large
QuotaArnstring

The Alibaba Cloud Resource Name (ARN) of the quota.

acs:quotas:cn-hangzhou:*:quota/ecs/ecs.m2.medium/prepaid/classic/instancetype/cn-hangzhou-b
QuotaDescriptionstring

The description of the quota.

ecs.c5.large
QuotaNamestring

The name of the quota.

ecs.c5.large
QuotaUnitstring

The unit of the quota.

AMOUNT
Reasonstring

The reason for the application.

Scale Out
RequestIdstring

The ID of the request.

D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053
Statusstring

The approval state of the quota increase application.

Valid values:

  • Cancel: The application is canceled.
  • Agree: The application is approved.
  • Process: The application is in review.
  • Disagree: The application is rejected.
Process

Examples

Sample success responses

JSONformat

{
  "ApplicationId": "d314d6ae-867d-484c-9009-3d421a80****",
  "ApplyTime": "2021-01-19T09:25:56Z",
  "ApproveValue": 804,
  "AuditReason": "Agree\n",
  "DesireValue": 12,
  "Dimension": {
    "regionId": "cn-hangzhou"
  },
  "EffectiveTime": "2021-01-19T09:25:56Z",
  "ExpireTime": "2021-01-20T09:25:56Z",
  "NoticeType": 3,
  "ProductCode": "ecs-spec",
  "QuotaActionCode": "ecs.c5.large",
  "QuotaArn": "acs:quotas:cn-hangzhou:*:quota/ecs/ecs.m2.medium/prepaid/classic/instancetype/cn-hangzhou-b",
  "QuotaDescription": "ecs.c5.large",
  "QuotaName": "ecs.c5.large",
  "QuotaUnit": "AMOUNT",
  "Reason": "Scale Out\n",
  "RequestId": "D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053",
  "Status": "Process"
}

Error codes

HTTP status codeError codeError messageDescription
400ACQUIRE.LOCK.FAILThe request is too frequent. Please try again later.Too many attempts. Try again later.
400InvalidNoticeTypeInvalid NoticeTypeThe specified NoticeType parameter is invalid.
400InvalidDesireValueInvalid DesireValueThe specified DesireValue parameter is invalid.
400QUOTA.NOT.ADJUSTABLEQuota is not adjustableThe quota is not adjustable.
400QUOTA.NOT.FOUNDThe quota does not exist.The quota does not exist.
400QUOTA.APPLICATION.PROCESSThe quota adjustment application is being processed. Please try again later.The quota application is being processed. You cannot submit an application at the time being.
400QUOTA.DESIREVALUE.ILLEGALThe applied quota value is invalid.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-22API Description Update. The Error code has changedView Change Details