获取环境参数分组列表
功能介绍
获取环境参数分组列表
URI
GET /v1/projects/{project_id}/environments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Long |
参数解释 起始偏移量，表示从此偏移量开始查询， offset大于等于0 约束限制 不涉及 取值范围 0-999 默认取值 不涉及 |
|
limit |
是 |
Long |
参数解释 每页显示的条目数量,最大支持200条 约束限制 不涉及 取值范围 1-200 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
environments |
Array of Environment objects |
参数解释 环境分组列表 |
|
offset |
Long |
参数解释 偏移量，表示从此偏移量开始查询，offset大于等于0 取值范围 0-999 |
|
limit |
Long |
参数解释 每页显示的条目数量,最大支持200条 取值范围 1-200 |
|
total_count |
Long |
参数解释 环境分组总条数 取值范围 0-100 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
environment_id |
String |
参数解释 环境分组id 取值范围 32个字符组成的字符串 |
|
environment_name |
String |
参数解释 环境分组名 取值范围 3-50个字符组成的字符串 |
|
environment_description |
String |
参数解释 环境分组描述 取值范围 0-300个字符组成的字符串 |
|
is_default |
Boolean |
参数解释 是否是默认环境 取值范围 false或者true，true表示为默认环境分组，false表示非默认环境分组 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-16个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-100个字符组成的字符串 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
无
响应示例
状态码：200
OK
{
"environments" : [ {
"environment_id" : "ff4893796ee1a8aa009ff3a470de55d8",
"environment_name" : "默认环境",
"environment_description" : "默认环境",
"is_default" : true
} ],
"offset" : 0,
"limit" : 1,
"total_count" : 50
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
