使用ListEnvCustomJobs API查询环境的自定义Job列表-可观测监控 Prometheus 版-阿里云-可观测监控 Prometheus 版(Prometheus)-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

arms:ListEnvCustomJobs

list

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
EnvironmentId	string	是	环境实例 ID。	env-xxxxx
EncryptYaml	boolean	否	是否返回加密后的 yaml。	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Code	integer	状态码。200 表示成功。	200
Data	array<object>	返回结构体。
	array<object>	返回结构体。
EnvironmentId	string	环境实例 ID。	env-xxxx
RegionId	string	地域 ID。	cn-hangzhou
CustomJobName	string	自定义 job 名称。	job1
ConfigYaml	string	请求参数 encryptYaml 为 true，则返回 base64 编码后的 yaml 串。否则返回明文 yaml 串。	参见补充说明。
Status	string	状态。	run
CreationTimestamp	string	创建时间（时间戳）。	2022-01-01T10:11:34Z
AddonName	string	归属的组件名。	mysql
AddonReleaseName	string	归属的组件实例名。	mysql1
AddonVersion	string	归属的组件版本。	1.1.0
ScrapeConfigs	array<object>	抓取配置。
	object	抓取配置。
JobName	string	Job 名。	custom-sd-demo
ScrapeInterval	string	抓取间隔。	30s
MetricsPath	string	抓取 metric 的路径。	/metrics
ScrapeDiscoverys	array	服务发现方式列表。
	string	服务发现方式。	static_configs
Message	string	返回结果的提示信息。	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"
}

错误码

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

变更历史

更多信息，参考变更详情。