文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ CMDB资源管理/ 获取组件下的环境列表- ListAppEnvs
更新时间:2025-11-11 GMT+08:00
分享

获取组件下的环境列表- ListAppEnvs

功能介绍

获取组件下的环境列表。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm:application:getEnv

    Read

    -

    g:EnterpriseProjectId

    apm:apm2BusinessEnv:get

    -

URI

GET /v1/apm2/openapi/cmdb/envs/get-app-envs

表1 Query参数

参数

是否必选

参数类型

描述

app_id

Long

组件id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-business-id

Long

应用id。

X-Auth-Token

String

从IAM服务获取的用户Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

envs

Array of EnvNodeModel objects

环境信息列表。

表4 EnvNodeModel

参数

参数类型

描述

id

Long

环境id。

app_id

Long

组件id。

name

String

环境名称。

is_default

Boolean

是否是默认环境。

business_id

Long

应用id。

region

String

区域。

data_source

String

数据来源。

请求示例

获取组件下环境列表,其中组件ID为11。

/v1/apm2/openapi/cmdb/envs/get-app-envs?app_id=11

响应示例

状态码: 200

OK,请求响应成功。

{
  "envs" : [ {
    "id" : 11,
    "app_id" : 11,
    "name" : "xxx-roma-2",
    "is_default" : false,
    "business_id" : 162,
    "region" : "xxx-roma-2"
  } ]
}

状态码

状态码

描述

200

OK,请求响应成功。

400

Bad Request,语义或参数有误。

401

Unauthorized,没有权限。

403

Forbidden,禁止访问。

404

Not Found,没有找到要请求的资源。

错误码

请参见错误码

相关文档