查询APP列表 - ListAppsV2
功能介绍
查询APP列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
apig:app:list
List
instance *
g:ResourceTag/<tag-key>
- apig:apps:list
apig:instance:get
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/apps
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
id |
否 |
String |
APP编号 |
|
name |
否 |
String |
APP名称 |
|
status |
否 |
Integer |
APP状态。
|
|
app_key |
否 |
String |
APP凭据的key。 |
|
creator |
否 |
String |
APP的创建者。
|
|
precise_search |
否 |
String |
指定需要精确匹配查找的参数名称，目前仅支持name |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
apps |
Array of AppInfoWithBindNum objects |
APP列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
编号 |
|
name |
String |
名称 |
|
remark |
String |
描述 |
|
creator |
String |
APP的创建者
暂不支持MARKET |
|
update_time |
String |
更新时间 |
|
app_key |
String |
APP凭据的key。 |
|
app_secret |
String |
密钥 |
|
register_time |
String |
注册时间 |
|
status |
Integer |
状态
|
|
app_type |
String |
APP的类型。
默认apig，暂不支持其他类型 |
|
roma_app_type |
String |
ROMA_APP的类型：
暂不支持 |
|
bind_num |
Integer |
绑定的API数量 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
OK
{
"total" : 2,
"size" : 2,
"apps" : [ {
"bind_num" : 0,
"creator" : "USER",
"update_time" : "2020-08-03T13:09:13Z",
"app_key" : "ee8f878c252747028f07eb116c2cd91b",
"name" : "app_demo",
"remark" : "Demo app",
"id" : "356de8eb7a8742168586e5daf5339965",
"app_secret" : "416************ab8",
"register_time" : "2020-08-03T13:09:13Z",
"status" : 1,
"app_type" : "apig"
}, {
"bind_num" : 3,
"creator" : "USER",
"update_time" : "2020-05-27T10:38:03.133586Z",
"app_key" : "840b8b5b1efc4ec686639759c2c584da",
"name" : "app_001",
"id" : "9ed8b7fe84224de681e7d7a5587e76dc",
"app_secret" : "0a4************c6e",
"register_time" : "2020-03-28T11:09:06Z",
"status" : 1
} ]
}
状态码：400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}
状态码：401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码：403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码：500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
错误码
请参见错误码。
