Query monitored services using DescribeProjectMeta - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Calls the DescribeProjectMeta operation to query the list of cloud services that support time series monitoring metrics in CloudMonitor.

Operation description

Obtains the information about the connected cloud services, including the description, namespace, and tags of each service.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Labels	string	No	The tags. Tags are used to filter alerts, and each alert can be marked with special tags. Currently, only filtering by product is supported. That is, the `name` is `product`. For example: {"name":"product","value":"ECS"}. Note We do not recommend that you use the special tags for the CloudMonitor console in Alibaba Cloud.	[{"name":"product","value":"ECS"}]
PageNumber	integer	No	The page number. Valid values: 1 to 100. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 10000. Default value: 30. Note Currently, Alibaba Cloud does not impose a limit on this parameter. If you need to obtain all results, set the page size to a large value.	30

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4C2061B2-3B1B-43BF-A4A4-C53426F479C0
Success	boolean	Indicates whether the operation was successful. Valid values: true and false. The value true indicates success, and the value false indicates failure.	true
Code	string	The status code. Note The value 200 indicates success.	200
Message	string	The error message.	The Request is not authorization.
PageSize	string	The number of entries per page.	5
PageNumber	string	The page number.	1
Total	string	The total number of entries.	12
Resources	object
Resource	array<object>	The information about the cloud service.
	object
Namespace	string	The namespace of the cloud service. Format: `acs_Service name abbreviation`. For more information about namespaces, see Appendix 1: Metrics.	acs_cdn
Description	string	The description.	CDN
Labels	string	The tags. Tags are used to filter services. Tags are returned in the following format: `[{"name":"Tag key","value":"Tag value"}, {"name":"Tag key","value":"Tag value"}]`. The following tags are commonly used: alertUnit: the unit of the metric value in alerts. If the unit is small, the original metric value may be too large. In this case, you can use the `alertUnit` tag to specify an appropriate unit. This tag is used in CloudMonitor. minAlertPeriod: the minimum time interval to report a new alert. The interval at which monitoring data is reported. The value is usually 1 minute. metricCategory: the service specification. Example: kvstore_sharding. Some Alibaba Cloud services have multiple specifications that are defined in the same namespace. This parameter is used to identify the specifications. is_alarm: indicates whether an alert rule can be configured. We recommend that you do not use the special tags in the CloudMonitor console.	[{"metricCategory":ecs}]

Examples

Success response

JSON format

{
  "RequestId": "4C2061B2-3B1B-43BF-A4A4-C53426F479C0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageSize": "5",
  "PageNumber": "1",
  "Total": "12",
  "Resources": {
    "Resource": [
      {
        "Namespace": "acs_cdn",
        "Description": "CDN",
        "Labels": "[{\"metricCategory\":ecs}]"
      }
    ]
  }
}

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.