CloudMonitor Resource Quota Limits & Usage Overview - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the quotas of various CloudMonitor resources.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeMonitorResourceQuotaAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ShowUsed	boolean	No	Specifies whether the response includes used quotas. Valid values: true (default): Included. false: Not included.	true

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

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note 200 indicates success.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	31BC7201-00F2-47B2-B7B9-6A173076ACE
ResourceQuota	object	The quota details of CloudMonitor.
SuitInfo	string	The current edition of CloudMonitor. Valid values: free: Free Edition. pro: Pro Edition. cms_post: Pay-as-you-go.	pro
InstanceId	string	The subscription plan ID.	cms_edition-cn-n6w20rn****
ExpireTime	string	The expiration time of the plan. The time follows the ISO 8601 standard in the YYYY-MM-DD format. The default time zone is UTC+8.	2021-02-28
SiteMonitorEcsProbe	object	The quota of ECS detection points for site monitoring.
QuotaLimit	integer	The total quota for site monitoring ECS detection points. Note The maximum number of ECS detection points that can be selected for a single site monitoring task.	5
QuotaPackage	integer	The quota for site monitoring ECS detection points included in the plan.	5
QuotaUsed	integer	The used quota for site monitoring ECS detection points in the plan. Note The total number of ECS detection points across all site monitoring tasks that have been created.	20
SiteMonitorOperatorProbe	object	The quota of carrier detection points for site monitoring.
QuotaLimit	integer	The total quota for site monitoring carrier detection points.	5
QuotaPackage	integer	The quota for site monitoring carrier detection points included in the plan.	5
QuotaUsed	integer	The used quota for site monitoring carrier detection points in the plan.	0
SiteMonitorTask	object	The quota of site monitoring tasks.
QuotaLimit	integer	The total quota for site monitoring tasks. Unit: count.	25
QuotaPackage	integer	The quota for site monitoring tasks included in the plan. Unit: count.	20
QuotaUsed	integer	The used quota for site monitoring tasks in the plan. Unit: count.	15
SiteMonitorBrowser	object	The quota of browser-based monitoring tasks.
QuotaLimit	integer	The total quota for browser-based monitoring tasks. Unit: count.	50
QuotaPackage	integer	The quota for browser-based monitoring tasks included in the plan. Unit: count.	50
QuotaUsed	integer	The used quota for browser-based monitoring tasks in the plan. Unit: count.	15
SiteMonitorMobile	object	The quota of mobile monitoring tasks.
QuotaLimit	integer	The total quota for mobile monitoring tasks. Unit: count.	50
QuotaPackage	integer	The quota for mobile monitoring tasks included in the plan. Unit: count.	50
QuotaUsed	integer	The used quota for mobile monitoring tasks in the plan. Unit: count.	15
CustomMonitor	object	The quota of custom monitoring.
QuotaLimit	integer	The total quota for custom monitoring time series. Unit: count.	1200
QuotaPackage	integer	The quota for custom monitoring time series included in the plan. Unit: count.	1000
QuotaUsed	integer	The used quota for custom monitoring time series in the plan. Unit: count.	8
EventMonitor	object	The quota of event monitoring.
QuotaLimit	integer	The total quota for event monitoring. Unit: 10,000.	55
QuotaPackage	integer	The quota for event monitoring included in the plan. Unit: 10,000.	50
QuotaUsed	integer	The used quota for event monitoring in the plan. Unit: 10,000.	2
LogMonitor	object	The quota of Log Monitoring.
QuotaLimit	integer	The total quota for Log Monitoring. Unit: MB/min.	150
QuotaPackage	integer	The quota for Log Monitoring included in the plan. Unit: MB/min.	150
QuotaUsed	integer	The used quota for Log Monitoring in the plan. Unit: MB/min.	80
Api	object	The API quota.
QuotaLimit	integer	The total API quota. Unit: 10,000 calls.	500
QuotaPackage	integer	The API quota included in the plan. Unit: 10,000 calls.	500
QuotaUsed	integer	The used API quota in the plan. Unit: calls.	9987
SMS	object	The quota of alert text message packages.
QuotaLimit	integer	The total quota for alert text messages. Unit: messages.	550
QuotaPackage	integer	The quota for alert text message packages. Unit: messages.	500
QuotaUsed	integer	The used quota for alert text message packages. Unit: messages.	38
Phone	object	The quota of alert phone call packages.
QuotaLimit	integer	The total quota for alert phone calls. Unit: calls.	550
QuotaPackage	integer	The quota for alert phone call packages. Unit: calls.	500
QuotaUsed	integer	The used quota for alert phone call packages. Unit: calls.	100
EnterpriseQuota	object	The quota details of Hybrid Cloud Monitoring.
SuitInfo	string	The description of Hybrid Cloud Monitoring.	ENTERPRISE
InstanceId	string	The instance ID of Hybrid Cloud Monitoring.	cms_enterprise_public_cn-7mz27pd****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "31BC7201-00F2-47B2-B7B9-6A173076ACE",
  "ResourceQuota": {
    "SuitInfo": "pro",
    "InstanceId": "cms_edition-cn-n6w20rn****",
    "ExpireTime": "2021-02-28",
    "SiteMonitorEcsProbe": {
      "QuotaLimit": 5,
      "QuotaPackage": 5,
      "QuotaUsed": 20
    },
    "SiteMonitorOperatorProbe": {
      "QuotaLimit": 5,
      "QuotaPackage": 5,
      "QuotaUsed": 0
    },
    "SiteMonitorTask": {
      "QuotaLimit": 25,
      "QuotaPackage": 20,
      "QuotaUsed": 15
    },
    "SiteMonitorBrowser": {
      "QuotaLimit": 50,
      "QuotaPackage": 50,
      "QuotaUsed": 15
    },
    "SiteMonitorMobile": {
      "QuotaLimit": 50,
      "QuotaPackage": 50,
      "QuotaUsed": 15
    },
    "CustomMonitor": {
      "QuotaLimit": 1200,
      "QuotaPackage": 1000,
      "QuotaUsed": 8
    },
    "EventMonitor": {
      "QuotaLimit": 55,
      "QuotaPackage": 50,
      "QuotaUsed": 2
    },
    "LogMonitor": {
      "QuotaLimit": 150,
      "QuotaPackage": 150,
      "QuotaUsed": 80
    },
    "Api": {
      "QuotaLimit": 500,
      "QuotaPackage": 500,
      "QuotaUsed": 9987
    },
    "SMS": {
      "QuotaLimit": 550,
      "QuotaPackage": 500,
      "QuotaUsed": 38
    },
    "Phone": {
      "QuotaLimit": 550,
      "QuotaPackage": 500,
      "QuotaUsed": 100
    },
    "EnterpriseQuota": {
      "SuitInfo": "ENTERPRISE",
      "InstanceId": "cms_enterprise_public_cn-7mz27pd****"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.