DocsICP FilingConsole
Documentation

ListEnvironments

Updated at:
Copy as MD
Product
My Favorites

Queries environments.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
EnvironmentType

string

No

The environment type. You must specify at least one of the AddonName and EnvironmentType parameters.

Valid values:

  • CS

    :

    Container Service for Kubernetes (ACK)

  • ECS

    :

    Elastic Compute Service (ECS)

  • Cloud

    :

    cloud service

Valid values:

  • CS :

    Container service

  • ECS :

    ECS service

  • Cloud :

    Cloud service

CS
RegionId

string

No

The region ID.

cn-hangzhou
AddonName

string

No

The add-on name. You must specify at least one of the AddonName and EnvironmentType parameters.

trace-java
ResourceGroupId

string

No

The ID of the resource group.

rg-aekzfurdatohtka
Tag

array<object>

No

The tags.

object

No

Resource tag value.

Key

string

No

The tag key.

env
Value

string

No

The tag value.

gfn_web_outbound_add
BindResourceId

string

No

The ID of the resource.

cb9229c48e41144dc96af190841808cb0
FeePackage

string

No

The payable resource plan.

  • If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Default value: CS_Basic.

  • Otherwise, leave the parameter empty.

Valid values:

  • CS_Pro: Container Monitoring Pro

  • CS_Basic: Container Monitoring Basic

Valid values:

  • CS_Pro :

    Container Monitoring Pro

  • CS_Basic :

    Container Monitoring Basi

CS_Pro
FilterRegionIds

string

No

The region IDs to be queried.

cn-beijing,cn-hangzhou

Response elements

Element

Type

Description

Example

object

response

RequestId

string

The request ID.

1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
Success

boolean

Indicates whether the request was successful. Valid values: true and false.

true
Code

integer

The HTTP status code. The status code 200 indicates that the request was successful.

200
Message

string

The returned message.

success
Data

object

The returned struct.

Environments

array<object>

The queried environments.

array<object>

Environment details.

Addons

array<object>

The add-ons.

object

Addon details.

Alias

string

The alias of the add-on.

Prometheus探针
Description

string

The description of the add-on.

以 Prometheus 采集规范采集 Metric 数据
Icon

string

The URL of the icon.

http://xxxx
Name

string

The name of the add-on.

metric-agent
UserId

string

The user ID.

13990957477389
BindResourceId

string

The ID of the resource bound to the environment instance. The resource can be a Kubernetes cluster or a VPC.

vpc-bp1bgo8ronn
BindResourceProfile

string

The profile that is bound to the resource.

xxx
BindResourceType

string

The resource type.

VPC
BindVpcCidr

string

The CIDR block that is bound to the VPC.

172.16.0.0/12
CreateTime

string

The time when the environment instance was created.

2023-03-24 11:58:35 +0800
CreatedUserId

string

The user ID.

12378523784982
EnvironmentId

string

The ID of the environment instance.

env-xxx
EnvironmentName

string

The name of the environment instance.

feiliks-biz-prod-edas
EnvironmentType

string

The type of the environment instance. Valid values:

  • CS: Container Service

  • ECS: Elastic Compute Service

  • Cloud: cloud service

Valid values:

  • CS :

    Container service

  • ECS :

    ECS service

  • Cloud :

    Cloud service

CS
Features

array<object>

The parameters of the feature.

object

Feature details.

Alias

string

The alias of the feature.

Prometheus 探针
Description

string

The description of the feature.

以 Prometheus 采集规范采集 Metric 数据
Icon

string

The URL of the icon.

http://xxx
Name

string

The name of the feature.

metirc-agent
GrafanaFolderTitle

string

The name of the Grafana directory.

filepath
GrafanaFolderUid

string

The unique ID of the Grafana directory.

1798319482935
PrometheusId

integer

The Prometheus ID.

124769812
PrometheusInstanceId

string

The ID of the Prometheus instance.

vpc-m5e4alj2i24ndbn
RegionId

string

The region ID.

cn-zhangjiakou
ResourceGroupId

string

The ID of the resource group.

rg-acfmvt3xpr5aema
Tags

array<object>

The tags of the environment resource.

object

Resource tag value.

Key

string

The tag key.

fpx-tag
Value

string

The tag value.

cn-beijing
GrafanaDatasourceUid

string

The unique ID of the Grafana data source.

12374890
ReleaseCount

integer

The number of installed add-ons.

122
LatestReleaseCreateTime

string

The time when the last add-on was created.

2023-09-22T16:56:29+08:00
ManagedType

string

Indicates whether agents or exporters are managed. Valid values:

  • none: No. By default, no managed agents or exporters are provided for ACK clusters.

  • agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.

  • agent-exproter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.

agent
FeePackage

string

The payable resource plan.

  • If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro.

  • Otherwise, leave the parameter empty.

CS_Pro
Total

integer

The total number of returned entries.

12

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.