查询环境的自定义Job列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:ListEnvCustomJobs | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| EnvironmentId | string | 是 | 环境实例 ID。 | env-xxxxx |
| EncryptYaml | boolean | 否 | 是否返回加密后的 yaml。 | true |
返回参数
示例
正常返回示例
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