获取环境参数分组列表
功能介绍
获取环境参数分组列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/projects/{project_id}/environments
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 最小长度：32 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
是 |
Long |
起始偏移量，表示从此偏移量开始查询， offset大于等于0 最小值：0 最大值：999 缺省值：0 |
limit |
是 |
Long |
每页显示的条目数量,最大支持200条 最小值：1 最大值：200 缺省值：200 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-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 最大长度：32 |
environment_name |
String |
环境分组名 最小长度：3 最大长度：80 |
environment_description |
String |
环境分组描述 最小长度：0 最大长度：500 |
is_default |
Boolean |
是否是默认环境 |
状态码： 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 |
错误码
请参见错误码。
