ListEnvCustomJobs - 查詢環境的自訂Job列表 - Application Real-Time Monitoring Service

查詢環境的自訂Job列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	Schema of Response
RequestId	string	Id of the request	2A0CEDF1-06FE-44AC-8E21-21A5BE65****
Code	integer	狀態代碼。200 表示成功。	200
Data	array<object>	返回結構體。
	array<object>	返回結構體。
EnvironmentId	string	環境執行個體 ID。	env-xxxx
RegionId	string	地區 ID。	cn-hangzhou
CustomJobName	string	自訂 job 名稱。	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	Job 名。	custom-sd-demo
ScrapeInterval	string	抓取間隔。	30s
MetricsPath	string	抓取 metric 的路徑。	/metrics
ScrapeDiscoverys	array	服務發現方式列表。
	string	服務發現方式。	static_configs
Message	string	返回結果的提示資訊。	success

樣本

正常返回樣本

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。