Queries the information of monitored services in CloudMonitor.

The information obtained by this operation includes the service description, namespace, and tags.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Labels String No [{"name":"product","value":"ECS"}]

The tags. Tags are used to filter services.

You can filter services only by the tag whose name is product. Example: {"name":"product","value":"ECS"}.

Note We recommend that you do not use the special tags in the CloudMonitor console.
PageNumber Integer No 1

The number of the page to return.

Valid values: 1 to 100.

Default value: 1.

PageSize Integer No 30

The number of entries to return on each page.

Valid values: 1 to 10000.

Default value: 30.

Note The value of this parameter is not limited. You can view a large number of entries per page.
Action String Yes DescribeProjectMeta

The operation that you want to perform. Set the value to DescribeProjectMeta.

Response parameters

Parameter Type Example Description
RequestId String 4C2061B2-3B1B-43BF-A4A4-C53426F479C0

The ID of the request.

Success Boolean true

Indicates whether the call was successful. The value true indicates success. The value false indicates failure.

Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String The Request is not authorization.

The error message.

PageSize String 5

The number of entries returned per page.

PageNumber String 1

The page number of the returned page.

Total String 12

The total number of returned entries.

Resources Array of Resource

The details of the cloud service.

Resource
Namespace String acs_cdn

The namespace of the cloud service. Format: acs_Service name abbreviation. For more information about namespaces, see Appendix 1: Metrics.

Description String CDN

The description of the cloud service.

Labels String [{"groupFlag":true}]

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 is usually set to 1 minute.

  • metricCategory: the specification of the service. Example: kvstore_sharding.

    An Alibaba Cloud service may have different specifications that are defined in the same namespace. You can use this parameter to distinguish between service specifications.

  • is_alarm: specifies whether an alert rule can be set.

    We recommend that you do not use the special tags in the CloudMonitor console.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeProjectMeta
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeProjectMeta>
		<PageNumber>1</PageNumber>
		<PageSize>5</PageSize>
		<RequestId>4C2061B2-3B1B-43BF-A4A4-C53426F479C0</RequestId>
		<Success>true</Success>
		<Code>200</Code>
		<Total>12</Total>
		<Resources>
			<Resource>
				<Description>AnalyticDB</Description>
				<Labels>[{"name":"product","value":"ADS"},{"name":"productCategory","value":"ads"},{"name":"groupFlag","value":"true"}]</Labels>
				<Namespace>acs_ads</Namespace>
			</Resource>
			<Resource>
				<Description>Artificial Intelligence Recommendation</Description>
				<Labels>[{"name":"product","value":"AIRec"},{"name":"productCategory","value":"airec"},{"name":"groupFlag","value":"true"}]</Labels>
				<Namespace>acs_airec</Namespace>
			</Resource>
			<Resource>
				<Description>API Gateway</Description>
				<Labels>[{"name":"product","value":"APIGateway"},{"name":"productCategory","value":"apigateway"},{"name":"groupFlag","value":"true"}]</Labels>
				<Namespace>acs_apigateway_dashboard</Namespace>
			</Resource>
			<Resource>
				<Description>CDN</Description>
				<Labels>[{"name":"product","value":"CDN"},{"name":"productCategory","value":"cdn"},{"name":"groupFlag","value":"true"}]</Labels>
				<Namespace>acs_cdn</Namespace>
			</Resource>
			<Resource>
				<Description>Cloud Enterprise Network</Description>
				<Labels>[{"name":"product","value":"CEN"},{"name":"productCategory","value":"cen,cen_flow,cen_vbr"},{"name":"groupFlag","value":"true"}]</Labels>
				<Namespace>acs_cen</Namespace>
			</Resource>
		</Resources>
</DescribeProjectMeta>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "PageSize" : 5,
  "RequestId" : "4C2061B2-3B1B-43BF-A4A4-C53426F479C0",
  "Success" : true,
  "Code" : 200,
  "Total" : 12,
  "Resources" : {
    "Resource" : [ {
      "Description" : "AnalyticDB",
      "Labels" : "[{\"name\":\"product\",\"value\":\"ADS\"},{\"name\":\"productCategory\",\"value\":\"ads\"},{\"name\":\"groupFlag\",\"value\":\"true\"}]",
      "Namespace" : "acs_ads"
    }, {
      "Description" : "Artificial Intelligence Recommendation",
      "Labels" : "[{\"name\":\"product\",\"value\":\"AIRec\"},{\"name\":\"productCategory\",\"value\":\"airec\"},{\"name\":\"groupFlag\",\"value\":\"true\"}]",
      "Namespace" : "acs_airec"
    }, {
      "Description" : "API Gateway",
      "Labels" : "[{\"name\":\"product\",\"value\":\"APIGateway\"},{\"name\":\"productCategory\",\"value\":\"apigateway\"},{\"name\":\"groupFlag\",\"value\":\"true\"}]",
      "Namespace" : "acs_apigateway_dashboard"
    }, {
      "Description" : "CDN",
      "Labels" : "[{\"name\":\"product\",\"value\":\"CDN\"},{\"name\":\"productCategory\",\"value\":\"cdn\"},{\"name\":\"groupFlag\",\"value\":\"true\"}]",
      "Namespace" : "acs_cdn"
    }, {
      "Description" : "Cloud Enterprise Network",
      "Labels" : "[{\"name\":\"product\",\"value\":\"CEN\"},{\"name\":\"productCategory\",\"value\":\"cen,cen_flow,cen_vbr\"},{\"name\":\"groupFlag\",\"value\":\"true\"}]",
      "Namespace" : "acs_cen"
    } ]
  }
}

Error codes

HTTP status code Error code Error message Description
404 ResourceNotFound The specified resource is not found. The error message returned because the specified resource is not found.

For a list of error codes, see Service error codes.