ListEnvServiceMonitors - 查询环境的ServiceMonitor列表_应用实时监控服务(ARMS)-阿里云帮助中心

查询环境的ServiceMonitor列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListEnvServiceMonitors	List	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
EnvironmentId	string	是	环境 ID。	env-xxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	1A474FF8-7861-4D00-81B5-5BC3DA4E****
Code	integer	状态码。200 表示成功。	200
Data	object []	返回结构体。
RegionId	string	地域 ID。	cn-beijing
EnvironmentId	string	环境 ID。	env-xxxxx
Namespace	string	命名空间。	arms-prom
ServiceMonitorName	string	ServiceMonitor 名称。	sm1
ConfigYaml	string	yaml 配置串。	参见补充说明。
Status	string	状态。	run
CreationTimestamp	string	创建时间（时间戳）。	2011-10-11T22:32:11Z
AddonName	string	归属的组件名。	mysql
AddonReleaseName	string	归属的组件实例名。	mysql1
AddonVersion	string	归属的组件版本。	1.1.0
MatchedServiceCount	integer	匹配出的 service 数量。	1
Endpoints	object []	ServiceMonitro 的端点列表。
Port	string	对外端口。	9101
TargetPort	integer	目标端口。	443
Path	string	采集路径。	/metrics
Interval	string	采集时间间隔。	30s
MatchedTargetCount	integer	servcieMonitor.Endpoint 匹配出的 target 数量。	1
Message	string	返回结果的提示信息。	success

示例

正常返回示例

JSON格式

{
  "RequestId": "1A474FF8-7861-4D00-81B5-5BC3DA4E****",
  "Code": 200,
  "Data": [
    {
      "RegionId": "cn-beijing",
      "EnvironmentId": "env-xxxxx",
      "Namespace": "arms-prom",
      "ServiceMonitorName": "sm1",
      "ConfigYaml": "参见补充说明。",
      "Status": "run",
      "CreationTimestamp": "2011-10-11T22:32:11Z",
      "AddonName": "mysql",
      "AddonReleaseName": "mysql1",
      "AddonVersion": "1.1.0",
      "MatchedServiceCount": 1,
      "Endpoints": [
        {
          "Port": "9101",
          "TargetPort": 443,
          "Path": "/metrics",
          "Interval": "30s",
          "MatchedTargetCount": 1
        }
      ]
    }
  ],
  "Message": "success"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史

ConfigYaml 示例：

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: arms-admin1
  namespace: arms-prom
  annotations:
    arms.prometheus.io/discovery: 'true'
spec:
  endpoints:
  - interval: 30s
    port: operator
    path: /metrics
  - interval: 10s
    port: operator1
    path: /metrics
  namespaceSelector:
    any: true
  selector:
    matchLabels:
     app: arms-prometheus-ack-arms-prometheus