文档首页/ API网关 APIG/ API参考/ 专享版API（V1）（待下线）/ APP授权管理（待下线）/ 查看API已绑定的APP列表
更新时间：2022-08-30 GMT+08:00
查看PDF
分享

查看API已绑定的APP列表

功能介绍

查询API绑定的APP列表。

URI

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

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

请求方法

URI

GET

/v1/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps[?page_size, page_no, api_id, app_name, app_id, env_id]
  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值：api_id、app_name、app_id、env_id、page_size、page_no。

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

表2 参数说明

名称

是否必选

类型

说明

project_id

是

String

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

instance_id

是

String

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

api_id

否

String

API编号

app_name

否

string

APP名称

app_id

否

String

APP编号

env_id

否

String

环境编号

page_size

否

Integer

每页显示的条数，默认值：20

page_no

否

Integer

页码，默认值：1

请求消息

无

响应消息

表3 参数说明

名称

类型

说明

total

Integer

符合条件的APP总数

size

Integer

本次返回的列表长度

auths

字典数据类型

本次返回的APP列表
表4 auths参数说明

名称

类型

说明

id

String

授权关系编号

api_id

String

API的编号

api_name

String

API的名称

group_name

String

API绑定的分组

api_remark

String

API的描述信息

api_type

Integer

API类型

envname

String

api授权绑定的环境

auth_role

String

授权者

auth_time

String

授权创建的时间

appid

String

APP的编号

app_name

String

APP的名称

app_creator

String

APP的创建者，取值如下：

  • USER：租户自己创建
  • MARKET：API市场分配

publish_id

String

API发布ID

env_id

String

环境ID

app_remark

String

APP的描述

app_type

String

APP类型

响应消息样例：

{
	"total": 1,
	"size": 1,
	"auths": [{
		"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a",
		"api_id": "6632a062-9dcf-4f18-9646-3cabb925a290",
		"api_name": "查询API列表",
		"group_name": "api_group_001",
		"api_type": 1,
		"api_remark": "查询API列表",
		"envname": "RELEASE",
		"auth_role": "PROVIDER",
		"auth_time": "2017-12-28T12:46:43Z",
		"appid": "14b399ac-967f-4115-bb62-c0346b4537e9",
		"app_name": "app_001",
		"app_creator": "USER",
                "publish_id": "fe9d8ea9f9424594abc3bbe8d861c0f0",
                "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
                "app_remark": "",
                "app_type": "apig"
	}]
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

相关文档