文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试设置/ 查询单个环境标签 - GetEnvironmentLabel
更新时间:2026-06-12 GMT+08:00
分享

查询单个环境标签 - GetEnvironmentLabel

功能介绍

此接口用于查询单个环境标签详情

调用方法

请参见如何调用API

URI

GET /v4/{project_id}/environmentlabel/{label_uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

label_uri

String

参数解释

标签URI

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的所有记录数

value

EnvironmentLabelResp object

环境标签

reason

String

错误信息

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表3 EnvironmentLabelResp

参数

参数类型

描述

uri

String

标签唯一标识

label_name

String

环境标签名称

description

String

环境标签描述

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

查询单个环境标签详情

get https://{endpoint}/v4/{project_id}/environmentlabel/{label_uri}

{
  "project_id" : "098ad17656684cc5a49a4f7007517f95",
  "label_uri" : "label-001"
}

响应示例

状态码:200

OK

{
  "total" : 1,
  "value" : {
    "uri" : "label-001",
    "label_name" : "开发环境",
    "description" : "开发测试环境",
    "created_at" : 1700000000000
  },
  "reason" : "",
  "page_size" : 20,
  "page_no" : 1,
  "has_more" : false
}

状态码:400

Bad Request

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码:500

Internal Server Error

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档