ListEnvironments - 查詢環境列表 - Application Real-Time Monitoring Service

查詢環境列表。

調試

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

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
EnvironmentType	string	否	環境類型， AddonName 和 EnvironmentType 至少填一個。枚舉值： CS : Container Service ECS : ECS 服務 Cloud : 雲端服務	CS
RegionId	string	否	地區 ID。	cn-hangzhou
AddonName	string	否	Addon 的名稱，AddonName 和 EnvironmentType 至少填一個。	trace-java
ResourceGroupId	string	否	資源群組 ID。	rg-aekzfurdatohtka
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	標籤鍵。	env
Value	string	否	標籤值。	gfn_web_outbound_add
BindResourceId	string	否	綁定的資源 ID。	cb9229c48e41144dc96af190841808cb0
FeePackage	string	否	付費套餐。 EnvironmentType 為 CS 時：可以指定為 CS_Basic（預設值）或 CS_Pro。 EnvironmentType 為其它值時，請輸入空值。枚舉值： CS_Pro : 容器監控 Pro 版 CS_Basic : 容器監控基礎版	CS_Pro
FilterRegionIds	string	否	指定 Region 查詢。	cn-beijing,cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	response
RequestId	string	Id of the request	1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
Success	boolean	操作是否成功：true：操作成功 false：操作失敗。	true
Code	integer	狀態代碼。200 表示成功。	200
Message	string	返回結果的提示資訊。	success
Data	object	返回結構體。
Environments	array<object>	環境集合。
	array<object>	環境集合。
Addons	array<object>	Addon 集合。
	object	Addon 詳情。
Alias	string	Addon 別名。	Prometheus探針
Description	string	Addon 描述。	以 Prometheus 採集規範採集 Metric 資料
Icon	string	表徵圖地址。	http://xxxx
Name	string	Addon 名稱。	metric-agent
UserId	string	使用者識別碼。	13990957477389
BindResourceId	string	環境綁定的資源執行個體 ID，包括容器執行個體 ID 或 VPCID。	vpc-bp1bgo8ronn
BindResourceProfile	string	綁定資源的 Profile。	xxx
BindResourceType	string	綁定的資源類型。	VPC
BindVpcCidr	string	綁定 VPC 的網段。	172.16.0.0/12
CreateTime	string	建立時間。	2023-03-24 11:58:35 +0800
CreatedUserId	string	建立的使用者識別碼。	12378523784982
EnvironmentId	string	環境執行個體 ID。	env-xxx
EnvironmentName	string	環境名稱。	feiliks-biz-prod-edas
EnvironmentType	string	環境類型： CS：Container Service。 ECS。 Cloud：雲端服務。枚舉值： CS : Container Service ECS : ECS Cloud : 雲端服務	CS
Features	array<object>	Feature 列表。
	object	Feature 詳情。
Alias	string	Feature 別名。	Prometheus 探針
Description	string	Feature 描述。	以 Prometheus 採集規範採集 Metric 資料
Icon	string	Feature 表徵圖地址。	http://xxx
Name	string	Feature 名稱。	metirc-agent
GrafanaFolderTitle	string	Grafana 目錄名。	filepath
GrafanaFolderUid	string	Grafana 目錄唯一 ID。	1798319482935
PrometheusId	integer	Prometheus 的 ID。	124769812
PrometheusInstanceId	string	綁定的 Prometheus 執行個體 ID。	vpc-m5e4alj2i24ndbn
RegionId	string	地區 ID。	cn-zhangjiakou
ResourceGroupId	string	資源群組 ID。	rg-acfmvt3xpr5aema
Tags	array<object>	環境資源標籤。
	object	標籤列表。
Key	string	標籤的鍵。	fpx-tag
Value	string	標籤的值。	cn-beijing
GrafanaDatasourceUid	string	Grafana 資料來源唯一 ID。	12374890
ReleaseCount	integer	已安裝 Addon 的數量。	122
LatestReleaseCreateTime	string	最後一次 Addon 建立的時間。	2023-09-22T16:56:29+08:00
ManagedType	string	託管類型： none：非託管。ACK 叢集的預設值。 agent：託管 agent（含 ksm）。ASK、ACS、AckOne 叢集的預設值。 agent-exproter：託管 agent 和 exporter。雲端服務類型的預設值。	agent
FeePackage	string	付費套餐。 EnvironmentType 為 CS 時：可選為 CS_Basic 或 CS_Pro。 EnvironmentType 為其它值時，為空白值。	CS_Pro
Total	integer	總數。	12

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "Environments": [
      {
        "Addons": [
          {
            "Alias": "Prometheus探針",
            "Description": "以 Prometheus 採集規範採集 Metric 資料",
            "Icon": "http://xxxx",
            "Name": "metric-agent"
          }
        ],
        "UserId": "13990957477389",
        "BindResourceId": "vpc-bp1bgo8ronn",
        "BindResourceProfile": "xxx",
        "BindResourceType": "VPC",
        "BindVpcCidr": "172.16.0.0/12",
        "CreateTime": "2023-03-24 11:58:35 +0800",
        "CreatedUserId": "12378523784982",
        "EnvironmentId": "env-xxx",
        "EnvironmentName": "feiliks-biz-prod-edas",
        "EnvironmentType": "CS",
        "Features": [
          {
            "Alias": "Prometheus 探針",
            "Description": "以 Prometheus 採集規範採集 Metric 資料",
            "Icon": "http://xxx",
            "Name": "metirc-agent"
          }
        ],
        "GrafanaFolderTitle": "filepath",
        "GrafanaFolderUid": "1798319482935",
        "PrometheusId": 124769812,
        "PrometheusInstanceId": "vpc-m5e4alj2i24ndbn",
        "RegionId": "cn-zhangjiakou",
        "ResourceGroupId": "rg-acfmvt3xpr5aema",
        "Tags": [
          {
            "Key": "fpx-tag",
            "Value": "cn-beijing"
          }
        ],
        "GrafanaDatasourceUid": "12374890",
        "ReleaseCount": 122,
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00",
        "ManagedType": "agent",
        "FeePackage": "CS_Pro"
      }
    ],
    "Total": 12
  }
}

錯誤碼

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

變更歷史

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