错误码
4.1.2 查询应用列表
功能介绍
查询应用列表,支持条件查询,所有条件是并且的关系
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/instances/{instance_id}/apps
表4-7 路径参数
参数 是否必选 参数类型 描述
instance_id 是 String 实例ID 最小长度:0 最大长度:64 project_id 是 String 项目ID
最小长度:0 最大长度:64
表4-8 Query 参数
参数 是否必选 参数类型 描述
offset 否 Integer 偏移量,大于等于0
最小值:0 最大值:10000 缺省值:0
limit 否 Integer 每页显示的条目数量
最小值:1 最大值:500 缺省值:10
参数 是否必选 参数类型 描述
favorite 否 Boolean 查询收藏的应用
● 未提供时,查询当前用户有 权限的所有应用
● 为true时,获取收藏的应用
● 为false时,获取未被收藏的 应用
auth_role 否 String 获取拥有指定权限应用 最小长度:0
最大长度:64
name 否 String 应用名称,模糊匹配
最小长度:0 最大长度:256
owner 否 Boolean 查询有权限访问的应用
● 未提供时,查询当前用户有 权限的所有应用
● 为true时,查询当前用户创 建的应用
● 为false时,查询非当前用户 创建的有权限的应用,比如 其它人共享的应用
user_name 否 String 从当前调用者有权限的所有应用 中过滤出指定用户名有权限的应 用
最小长度:0 最大长度:64
请求参数
表4-9 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取用户Token接口获取(响应 消息头中X-Subject-Token的 值)
最小长度:1 最大长度:100000
响应参数
状态码: 200
表4-10 响应 Body 参数
参数 参数类型 描述
total Integer 总的应用数量 最小值:1 最大值:10 size Integer 当前页的数量
最小值:1 最大值:10 apps Array of
ServerAppInf o objects
应用信息
表4-11 ServerAppInfo
参数 参数类型 描述
id String 应用ID
name String 应用名称
● 字符集:支持中文、英文字母、数字、中划 线、下划线、点、空格和中英文圆括号
● 约束:实例下唯一 remark String 应用描述
roles Array of
strings 应用权限角色
● read:应用下资源只读权限,至少要存在此权 限,包括API调试
● access:应用下资源的访问管理权限
● delete:应用下资源的删除权限
● modify:应用下资源的修改权限,包括API发 布、下线
● admin:应用和应用下资源的权限
● 仅提供admin时,会自动应用其它所有权限
● 未提供read时会自动应用read权限 create_time String 创建时间
最小值:1 最大值:128
参数 参数类型 描述 update_time String 更新时间
最小值:1 最大值:128 created_user created_user
object 创建用户信息 last_updated_
user last_updated
_user object 最后更新用户信息 owner Boolean 是否是应用拥有者
key String 应用认证访问KEY,未提供时随机生成
● 字符集:支持中文、英文字母、数字、中划 线、下划线、@号和点,以字母或中文或数字 开头
● 约束:实例下唯一
favorite Boolean 是否收藏应用,收藏的应用会在列表里优先显示
表4-12 created_user
参数 参数类型 描述
user_id String 创建应用的用户ID user_name String 创建应用的用户名称
表4-13 last_updated_user
参数 参数类型 描述
user_id String 最后修改者的用户ID user_name String 最后修改者的用户名
状态码: 403
表4-14 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 最小长度:1 最大长度:128
参数 参数类型 描述 error_msg String 错误消息
最小长度:1 最大长度:128 error_details String 具体错误消息
最小长度:1 最大长度:128 request_id String 请求处理ID
最小长度:1
"id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3", "name" : "AppName",
"remark" : "example"
} ],
"roles" : [ "read, access, delete, modify, admin," ], "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z", "created_user" : {
"user_id" : "string", "user_name" : "string"
}, "last_updated_user" : { "user_id" : "string", "user_name" : "string"
}, "owner" : "true,",
"key" : "TEI95R8RZ2pIf8UM", "favorite" : true
}
状态码: 403 Forbidden
{ "error_code" : "ROMA.00000101", "error_msg" : "error summary",
"error_details" : "some error details here",
"request_id" : "13760c1fe8655e61209b75665e9bef43"
}
状态码
状态码 描述
200 ok
403 Forbidden
错误码
请参见错误码。