更新时间:2022-06-27 GMT+08:00
分享

查询APP列表

功能介绍

查询APP列表。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1/{project_id}/apigw/instances/{instance_id}/apps[?page_size, page_no, id, name, app_key, creator]

  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值:id、name、app_key、creator、page_size、page_no。

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

project_id

String

项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。

instance_id

String

实例ID,可从API网关控制台的专享版实例信息中获取。

id

String

编号

name

String

名称

status

Integer

状态

app_key

String

APP的KEY

creator

String

APP的创建者,取值如下:

  • USER:用户自行创建
  • MARKET:云市场分配

page_size

Integer

每页显示的条数,默认值:20

page_no

Integer

页码,默认值:1

precise_search

String

指定需要精确匹配查找的参数名称,目前仅支持name

请求消息

响应消息

表3 参数说明

名称

类型

说明

total

Integer

符合条件的APP总数

size

Integer

本次查询返回的列表长度

apps

字典数据类型

APP列表

表4 apps参数说明

参数

类型

说明

id

String

编号

name

String

名称

status

Integer

状态

app_key

String

APP的key

app_secret

String

密钥

register_time

Timestamp

注册时间

remark

String

描述

update_time

Timestamp

更新时间

creator

String

APP的创建者,取值如下:

  • USER:用户自行创建
  • MARKET:云市场分配

app_type

String

APP类型,默认为apig

bind_num

Integer

绑定的API数量

响应消息样例:
{
	"total": 2,
	"size": 2,
	"apps": [{
		"id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
		"name": "app_002",
		"status": 1,
		"app_key": "f627fbaa-2c8b-4f58-a690-f478f54d3fe2",
		"app_secret": "******",
		"remark": "第二个APP",
		"register_time": "2017-12-28T12:32:50Z",
		"update_time": "2017-12-28T12:32:50Z",
		"creator": "MARKET",
                "app_type": "apig",
                "bind_num": 2
	},
	{
		"id": "14b399ac-967f-4115-bb62-c0346b4537e9",
		"name": "app_001",
		"status": 1,
		"app_key": "d49b1cbf-cc81-4a5f-b2a0-61b568e376eb",
		"app_secret": "******",
		"remark": "第一个APP",
		"register_time": "2017-12-28T12:26:54Z",
		"update_time": "2017-12-28T12:29:35.571Z",
		"creator": "USER",
                "app_type": "apig",
                "bind_num": 2
	}]
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error

分享:

    相关文档

    相关产品

close