更新时间:2024-04-29 GMT+08:00
分享

查询环境标签

功能介绍

查询环境标签接口。

调试

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

URI

POST /v1/apm2/openapi/cmdb/tag/get-env-tag-list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

x-business-id

Long

应用id。

表2 请求Body参数

参数

是否必选

参数类型

描述

business_id

Long

应用id。

keyword

String

关键字。

page_enable

Boolean

是否分页。

page_number

Integer

每页容量。

page_size

Integer

当前页码。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

env_tags

Array of CmdbTagEntity objects

环境标签数据列表。

total_count

Integer

总条数。

表4 CmdbTagEntity

参数

参数类型

描述

name

String

环境标签名称。

business_id

Long

应用id。

uuid

String

UUID。

descp

String

描述信息。

creator_id

Long

创建者id。

env_id_list

Array of integers

环境id列表。

id

Long

环境标签id。

gmt_create

String

创建时间。

gmt_modify

String

修改时间。

请求示例

查询应用ID为162的环境标签,查询结果不分页。

/v1/apm2/openapi/cmdb/tag/get-env-tag-list

{
  "business_id" : 162,
  "page_enable" : false
}

响应示例

状态码: 200

OK,请求响应成功。

{
  "env_tags" : [ {
    "name" : "xxx-roma-2",
    "businessId" : 162,
    "uuid" : "e9c8f632*********cbfcfa148c0",
    "descp" : null,
    "creatorId" : null,
    "envIdList" : null,
    "id" : 72,
    "gmt_create" : "2022-10-25T02:18:44.000+00:00",
    "gmt_modify" : "2022-10-25T02:18:44.000+00:00"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

OK,请求响应成功。

400

Bad Request,语义或参数有误。

401

Unauthorized,没有权限。

403

Forbidden,禁止访问。

404

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

错误码

请参见错误码

分享:

    相关文档

    相关产品