全部产品
Search

搜索本产品

    可观测监控 Prometheus 版：ListEnvCustomJobs - 查询环境的自定义Job列表

    文档中心

    可观测监控 Prometheus 版：ListEnvCustomJobs - 查询环境的自定义Job列表

    更新时间：Nov 05, 2024

    查询环境的自定义Job列表。

    调试

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

    授权信息

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

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

    请求参数

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

    地域 ID。

    		cn-hangzhou
    EnvironmentIdstring是

    环境实例 ID。

    		env-xxxxx
    EncryptYamlboolean否

    是否返回加密后的 yaml。

    		true

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    Id of the request

    		2A0CEDF1-06FE-44AC-8E21-21A5BE65****
    Codeinteger

    状态码。200 表示成功。

    		200
    Dataarray<object>

    返回结构体。

    Monitoringobject

    返回结构体。

    EnvironmentIdstring

    环境实例 ID。

    		env-xxxx
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    CustomJobNamestring

    自定义 job 名称。

    		job1
    ConfigYamlstring

    请求参数 encryptYaml 为 true，则返回 base64 编码后的 yaml 串。否则返回明文 yaml 串。

    		参见补充说明。
    Statusstring

    状态。

    		run
    CreationTimestampstring

    创建时间（时间戳）。

    		2022-01-01T10:11:34Z
    AddonNamestring

    归属的组件名。

    		mysql
    AddonReleaseNamestring

    归属的组件实例名。

    		mysql1
    AddonVersionstring

    归属的组件版本。

    		1.1.0
    ScrapeConfigsarray<object>

    抓取配置。

    scrapeConfigobject

    抓取配置。

    JobNamestring

    Job 名。

    		custom-sd-demo
    ScrapeIntervalstring

    抓取间隔。

    		30s
    MetricsPathstring

    抓取 metric 的路径。

    		/metrics
    ScrapeDiscoverysarray

    服务发现方式列表。

    scrapeDiscoverystring

    服务发现方式。

    		static_configs
    Messagestring

    返回结果的提示信息。

    		success

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Code": 200,
  "Data": [
    {
      "EnvironmentId": "env-xxxx",
      "RegionId": "cn-hangzhou",
      "CustomJobName": "job1",
      "ConfigYaml": "参见补充说明。",
      "Status": "run",
      "CreationTimestamp": "2022-01-01T10:11:34Z",
      "AddonName": "mysql",
      "AddonReleaseName": "mysql1",
      "AddonVersion": "1.1.0",
      "ScrapeConfigs": [
        {
          "JobName": "custom-sd-demo",
          "ScrapeInterval": "30s",
          "MetricsPath": "/metrics",
          "ScrapeDiscoverys": [
            "static_configs"
          ]
        }
      ]
    }
  ],
  "Message": "success"
}

    错误码

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

    变更历史

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

    ConfigYaml 示例：

    scrape_configs:
- job_name: job-demo1
  honor_timestamps: false
  honor_labels: false
  scrape_interval: 30s
  scheme: http
  metrics_path: /metric
  static_configs:
  - targets:
    - 127.0.0.1:9090
- job_name: job-demo2
  honor_timestamps: false
  honor_labels: false
  scrape_interval: 30s
  scheme: http
  metrics_path: /metric
  static_configs:
  - targets:
    - 127.0.0.1:9090
  http_sd_configs:
  - url: 127.0.0.1:9090
    refresh_interval: 30s