全部产品
Search
文档中心

应用实时监控服务ARMS:DescribeEnvCustomJob - 查询环境CustomJob详情

更新时间:Aug 28, 2026

查询环境CustomJob详情。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

EnvironmentId

string

是

环境实例 ID。

env-xxxxxx

CustomJobName

string

是

自定义 job 名称。

customJob1

EncryptYaml

boolean

否

是否返回加密后的 YAML 串。

true

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

6A9AEA84-7186-4D8D-B498-4585C6A2****

Code

integer

状态码。说明 200 表示成功。

200

Data

object

返回结构体。

EnvironmentId

string

环境实例 ID。

env-xxxxx

RegionId

string

地域 ID。

cn-hangzhou

CustomJobName

string

自定义 job 名称。

customJob1

ConfigYaml

string

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

参见补充说明。

Status

string

状态:

  • run

  • stop

枚举值:

  • stop :

    stop

  • run :

    run

run

Message

string

返回结果的提示信息。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "6A9AEA84-7186-4D8D-B498-4585C6A2****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "RegionId": "cn-hangzhou",
    "CustomJobName": "customJob1",
    "ConfigYaml": "参见补充说明。",
    "Status": "run"
  },
  "Message": "success"
}

错误码

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

变更历史

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