ListCmsInstances - 查询云服务采集状态 - 应用实时监控服务ARMS

目前该API接口已标记为弃用，推荐使用替代API：ARMS(2019-08-08) - ListEnvironmentAddons。

查询云服务采集状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListCmsInstances	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	是	集群 ID。	n9p9o9o3se
TypeFilter	string	是	集成的云服务类型。包括： direct: 云产品自监控集成 cms: 企业云监控集成	direct

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1
Data	object	返回结构体。
EnableTag	boolean	是否采集云产品相关 aliyun tag 标签。	true
Products	array<object>	返回结构体。
Products	object	返回结构体。
Descr	string	产品描述。	-
Instance	string	实例名称。	cloudserver
Prod	string	产品的代码。	face
Name	string	接入的云产品名称。	hologres
Id	string	实例 ID。	20210
State	string	Integration 的接入状态。 `true`：表示已接入。 `false`：表示未接入。	true
Time	string	Grafana 大盘创建时间的时间戳。	1647852021000
Type	string	产品类型。	HOLOGRES
Url	string	Grafana 大盘的完整 URL。	https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\u003d9\u0026refresh\u003d60s
Source	string	事件来源。	arms

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-02-05	OpenAPI 变更为 deprecated，即将下线	查看变更详情
2022-09-01	OpenAPI 入参发生变更	查看变更详情