ListEnvCustomJobs - 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:ListEnvCustomJobs

list

*Environment

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
EnvironmentId	string	必須	環境インスタンスの ID。	env-xxxxx
EncryptYaml	boolean	任意	暗号化された YAML 文字列を返すかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマです。
RequestId	string	リクエスト ID です。	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Code	integer	HTTP ステータスコードです。ステータスコード 200 は、リクエストが成功したことを示します。	200
Data	array<object>	返される構造体です。
	array<object>	返されるデータです。
EnvironmentId	string	環境インスタンスの ID です。	env-xxxx
RegionId	string	リージョン ID です。	cn-hangzhou
CustomJobName	string	カスタムジョブの名前です。	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	ジョブの名前です。	custom-sd-demo
ScrapeInterval	string	スクレイプ間隔です。	30s
MetricsPath	string	メトリクスパスです。	/metrics
ScrapeDiscoverys	array	サービスディスカバリーの方法です。
	string	サービスディスカバリーの方法です。	static_configs
Message	string	返されるメッセージです。	success

例

成功レスポンス

JSONJSON

{
  "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"
}

エラーコード

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

変更履歴

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