DescribeEnvCustomJob - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:DescribeEnvCustomJob

get

*Environment

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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"
}

エラーコード

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

変更履歴

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