すべてのプロダクト
Search
ドキュメントセンター

Managed Service for Prometheus:DescribeEnvCustomJob

最終更新日:Apr 10, 2026

環境のカスタムジョブの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-hangzhou

EnvironmentId

string

必須

環境インスタンスの ID。

env-xxxxxx

CustomJobName

string

必須

カスタムジョブの名前。

customJob1

EncryptYaml

boolean

任意

暗号化された YAML 文字列を返すかどうかを指定します。

true

レスポンスフィールド

フィールド

説明

object

応答のスキーマ。

RequestId

string

リクエスト ID。

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

Code

integer

HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。

200

Data

object

返される構造体。

EnvironmentId

string

環境インスタンスの ID。

env-xxxxx

RegionId

string

リージョン ID。

cn-hangzhou

CustomJobName

string

カスタムジョブの名前。

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

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。