DescribeEnvServiceMonitor - 查询环境的ServiceMonitor详情

查询环境的ServiceMonitor详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:DescribeEnvServiceMonitorget
  • Environment
    acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
EnvironmentIdstring

环境实例 ID。

env-xxxxx
Namespacestring

ServiceMonitor 所在的命名空间。

arms-prom
ServiceMonitorNamestring

ServiceMonitor 名称。

arms-admin1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

40B10E04-81E8-4643-970D-F1B38F2E****
Codeinteger

状态码。200 为成功,其他状态码为异常。

200
Dataobject

返回结构体。

EnvironmentIdstring

环境实例 ID。

env-xxxxx
Namespacestring

命名空间。

arms-prom
RegionIdstring

地域 ID。

cn-hangzhou
ServiceMonitorNamestring

ServiceMonitor 名称。

serviceMonitor1
ConfigYamlstring

ServiceMonitor 的 YAML 配置串。

参见补充说明。
Statusstring

状态:

  • run
  • stop
run
Messagestring

返回信息。

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-prometheusapiVersion: 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

示例

正常返回示例

JSON格式

{
  "RequestId": "40B10E04-81E8-4643-970D-F1B38F2E****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "Namespace": "arms-prom",
    "RegionId": "cn-hangzhou",
    "ServiceMonitorName": "serviceMonitor1",
    "ConfigYaml": "参见补充说明。",
    "Status": "run"
  },
  "Message": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史