ListEnvironments - 查询环境列表_应用实时监控服务(ARMS)-阿里云帮助中心

查询环境列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListEnvironments	list	Environment `acs:arms:{#regionId}:{#accountId}:environment/`	无	无

请求参数

名称	类型	必填	描述	示例值
EnvironmentType	string	否	环境类型， AddonName 和 EnvironmentType 至少填一个。枚举值： CS：容器服务。 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 查询。

返回参数

名称	类型	描述	示例值
	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>	环境集合。
environments	object	环境集合。
Addons	array<object>	Addon 集合。
addons	object	Addon 详情。
Alias	string	Addon 别名。	Prometheus探针
Description	string	Addon 描述。	以 Prometheus 采集规范采集 Metric 数据
Icon	string	图标地址。	http://xxxx
Name	string	Addon 名称。	metric-agent
UserId	string	用户 ID。	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	创建的用户 ID。	12378523784982
EnvironmentId	string	环境实例 ID。	env-xxx
EnvironmentName	string	环境名称。	feiliks-biz-prod-edas
EnvironmentType	string	环境类型： CS：容器服务。 ECS。 Cloud：云服务。	CS
Features	array<object>	Feature 列表。
features	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	long	Prometheus 的 ID。	124769812
PrometheusInstanceId	string	绑定的 Prometheus 实例 ID。	vpc-m5e4alj2i24ndbn
RegionId	string	地域 ID。	cn-zhangjiakou
ResourceGroupId	string	资源组 ID。	rg-acfmvt3xpr5aema
Tags	array<object>	环境资源标签。
tags	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	long	总数。	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
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-07-26	OpenAPI 入参发生变更	查看变更详情
2024-05-07	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-29	OpenAPI 入参发生变更	查看变更详情
2024-01-23	OpenAPI 返回结构发生变更	查看变更详情