查询应用下环境列表
功能介绍
查询应用下环境列表。
调用方法
请参见如何调用API。
URI
GET /v1/applications/{application_id}/environments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
application_id |
是 |
String |
参数解释: 应用id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
page_index |
否 |
Integer |
参数解释: 分页页码,表示从此页开始查询。 约束限制: 不涉及。 取值范围: 取值为[1~50]。 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 取值为[1~100]。 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: 要查询的环境名称。 约束限制: 不涉及。 取值范围: 最大长度为128个字符。 默认取值: 不涉及。 |
|
sort_key |
否 |
String |
参数解释: 排序字段。 约束限制: 不涉及。 取值范围:
默认取值: CREATED_TIME |
|
sort_dir |
否 |
String |
参数解释: 排序顺序。 约束限制: 不涉及。 取值范围:
默认取值: DESC |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 请求成功失败状态。 取值范围:
|
|
total |
Integer |
参数解释: 符合条件的环境数量。 取值范围: 0-100。 |
|
result |
Array of EnvironmentDetail objects |
参数解释: 环境列表信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 环境id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
name |
String |
参数解释: 环境名称。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 环境描述。 取值范围: 不涉及。 |
|
os |
String |
参数解释: 环境操作系统。 取值范围:
|
|
project_id |
String |
参数解释: 项目id,获取方式请参见获取项目id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
nick_name |
String |
参数解释: 环境创建者用户昵称。 取值范围: 字符串,长度为[1-30]个字符。 |
|
deploy_type |
Integer |
参数解释: 部署类型。 取值范围:
|
|
created_time |
String |
参数解释: 环境创建时间。时间格式:yyyy-MM-dd HH:mm:ss。 取值范围: 不涉及。 |
|
instance_count |
Integer |
参数解释: 环境下主机实例数量。 取值范围: 不涉及。 |
|
created_by |
UserInfo object |
参数解释: 环境创建者用户信息,包含用户id,用户名等。 |
|
permission |
EnvironmentPermissionDetail object |
参数解释: 当前用户对环境的操作权限矩阵。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_id |
String |
参数解释: 用户id。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
|
user_name |
String |
参数解释: 用户名。 取值范围: 只能由英文字母、数字组成,且长度为[1-255]个字符。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
can_delete |
Boolean |
参数解释: 当前用户是否有环境删除权限。 取值范围:
|
|
can_deploy |
Boolean |
参数解释: 当前用户是否有环境部署权限。 取值范围:
|
|
can_edit |
Boolean |
参数解释: 当前用户是否有环境编辑权限。 取值范围:
|
|
can_manage |
Boolean |
参数解释: 当前用户是否有环境权限矩阵编辑权限。 取值范围:
|
|
can_view |
Boolean |
参数解释: 当前用户是否有环境查看权限。 取值范围:
|
请求示例
https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments?project_id=55837d272adf4eee90319800e2da6961
响应示例
状态码:200
OK 请求响应成功
{
"status" : "success",
"total" : 1,
"result" : [ {
"created_by" : {
"user_id" : "6baa7454109d47c192f22078fe6cda20",
"user_name" : "devcloud_devcloud_l00490255_01"
},
"created_time" : "2023-06-20 16:53:29.0",
"deploy_type" : 0,
"description" : "",
"id" : "a0a2274acc4f482bb2ecf49f865879fa",
"name" : "casdasd",
"project_id" : "55837d272adf4eee90319800e2da6961",
"nick_name" : "AB边账号",
"instance_count" : 1,
"os" : "linux",
"permission" : {
"can_delete" : true,
"can_deploy" : true,
"can_edit" : true,
"can_manage" : true,
"can_view" : true
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功 |
错误码
请参见错误码。