ListCmsInstances-阿里云帮助中心

Queries the data collection status of cloud services.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

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
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	n9p9o9o3se
TypeFilter	string	No	The type of integrated cloud service. Valid values: `direct`: An integration for cloud products that are monitored by the product itself. `cms`: An integration with CloudMonitor.	direct

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1
Data	object	The returned data.
EnableTag	boolean	Indicates whether tag collection for the cloud product is enabled.	true
Products	array<object>	The list of cloud products.
	object	A cloud product.
Descr	string	The product description.	-
Instance	string	The instance name.	cloudserver
Prod	string	The product code.	face
Name	string	The name of the integrated cloud product.	hologres
Id	string	The instance ID.	20210
State	string	The integration status of the product. `true`: Integrated. `false`: Not integrated.	true
Time	string	The creation timestamp of the Grafana dashboard.	1647852021000
Type	string	The product type.	HOLOGRES
Url	string	The complete URL of the Grafana dashboard.	https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\u003d9\u0026refresh\u003d60s
Source	string	The event source.	arms

Examples

Success response

JSON format

{
  "RequestId": "E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1",
  "Data": {
    "EnableTag": true,
    "Products": [
      {
        "Descr": "-\n",
        "Instance": "cloudserver",
        "Prod": "face",
        "Name": "hologres",
        "Id": "20210",
        "State": "true",
        "Time": "1647852021000",
        "Type": "HOLOGRES",
        "Url": "https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\u003d9\\u0026refresh\\u003d60s",
        "Source": "arms"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.