API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

查询已购买的API列表

功能介绍

租户查询已购买的API列表。

URI

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

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

请求方法

URI

GET

/v1.0/apigw/purchases/apis[?page_size, page_no, api_id, api_name, group_id, group_name]

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

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

表2 参数说明

名称

是否必选

类型

说明

api_id

String

API编号

api_name

String

API名称

group_id

String

API分组编号

group_name

String

API分组名称

page_size

Integer

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

page_no

Integer

页码,默认值:1

请求消息

响应消息

表3 参数说明

名称

类型

说明

total

Integer

满足查询条件的API总数

size

Integer

本次查询返回的API个数

apis

字典数据类型

本次查询返回的API列表

表4 apis参数说明

参数

类型

说明

id

String

API编号

name

String

API名称

purchase_id

String

订购关系编号

remark

String

API描述

req_uri

String

API的访问地址

响应消息样例:

{
	"total": 3,
	"size": 3,
	"apis": [{
		"id": "cb498965-8acf-4c98-bd08-4033ef1fcfb4",
		"name": "查询环境列表",
		"purchase_id": "730f8a84-c8db-45ba-a6a5-2669ceb08574",
		"remark": "查询环境列表",
		"req_uri": "/envs"
	},
	{
		"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
		"name": "查询分组列表",
		"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
		"remark": "查询分组列表",
		"req_uri": "/groups"
	},
	{
		"id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"name": "查询API列表",
		"purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825",
		"remark": "查询API列表",
		"req_uri": "/apis"
	}]
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error

分享:

    相关文档

    相关产品