文档首页/ 应用性能管理 APM/ API参考（2.0）/ API/ CMDB/ 获取组件下的环境列表
更新时间：2024-04-29 GMT+08:00
查看PDF
分享

获取组件下的环境列表

功能介绍

获取组件下的环境列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

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。

gmt_create

String

创建时间。

gmt_modify

String

修改时间。

app_id

Long

组件id。

business_name

String

应用名称。

inner_domain_id

Integer

租户id。

name

String

环境名称。

is_default

Boolean

是否是默认环境。

app_name

String

组件名称。

business_id

Long

应用id。

region

String

区域。

请求示例

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

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

响应示例

状态码： 200

OK，请求响应成功。

{
  "envs" : [ {
    "id" : 11,
    "gmt_create" : null,
    "gmt_modify" : null,
    "app_id" : 11,
    "business_name" : null,
    "inner_domain_id" : null,
    "name" : "xxx-roma-2",
    "is_default" : false,
    "app_name" : null,
    "business_id" : 162,
    "region" : "xxx-roma-2"
  } ]
}

状态码

状态码

描述

200

OK，请求响应成功。

400

Bad Request，语义或参数有误。

401

Unauthorized，没有权限。

403

Forbidden，禁止访问。

404

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

错误码

请参见错误码。

父主题： CMDB

相关文档