APP授权管理-华为云

API网关 APIG-查看APP已绑定的API列表:响应消息

响应消息表3 参数说明名称类型说明 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths 字典数据类型本次返回的API列表表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授权绑定的环境名称 env_id String API授权绑定的环境编号 auth_role String 授权者 auth_time String 授权创建的时间 appid String APP的编号 app_name String APP的名称 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配 app_remark String APP的描述信息 app_type String APP的类型 publish_id String API的发布编号响应消息样例： {"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","env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","app_remark": "APP的描述信息","app_type": "apig","publish_id": "f500ba7e369b4b1ebae99aa9d114a17a"}]}

API网关 APIG APP授权管理（待下线）

API网关 APIG-查看APP已绑定的API列表:URI

URI HTTP/HTTPS请求方法以及URI如下表所示。表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。查询条件可为以下字段以及对应的值：app_id、 api_id 、 api_name、group_id、group_name、env_id、page_size、page_no。 URI中的参数说明如下表所示。表2 参数说明名称是否必选类型说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 app_id 是 String 应用编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 group_name 否 String API分组名称 env_id 否 String 授权的环境编号 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1

API网关 APIG APP授权管理（待下线）

API网关 APIG-查看APP未绑定的API列表:响应示例

响应示例状态码： 200 OK { "total" : 2, "size" : 2, "apis" : [ { "auth_type" : "APP", "run_env_name" : "", "group_name" : "api_group_001", "publish_id" : "", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_function", "remark" : "FunctionGraph backend API", "run_env_id" : "", "id" : "abd9c4b2ff974888b0ba79be7e6b2763", "req_uri" : "/test/function" }, { "auth_type" : "APP", "run_env_name" : "RELEASE", "group_name" : "APIGroup_d3da", "publish_id" : "ca2631e233a74a758744ae1e19cc5ad7", "group_id" : "6acd94abe58747ee8a73b10c70817bac", "name" : "API_test", "remark" : "FunctionGraph backend API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "11cbec3a7a8345ca981b86d161bc436e", "req_uri" : "/appcode" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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"} 状态码： 404 Not Found { "error_code" : "APIG.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

API网关 APIG 专享版-APP授权管理

API网关 APIG-查看APP未绑定的API列表:URI

URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。表2 Query参数参数是否必选参数类型描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 app_id 是 String 应用id env_id 是 String 环境id group_id 否 String API分组编号 api_id 否 String API编号 api_name 否 String API名称 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。最小长度：0 最大长度：128

API网关 APIG 专享版-APP授权管理

API网关 APIG-查看APP未绑定的API列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiOutline objects 本次返回的API列表表5 ApiOutline 参数参数类型描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。最小长度：1 最大长度：128 数组长度：0 - 10 状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-APP授权管理

应用与数据集成平台 ROMA Connect-查看APP下路径冲突的API列表:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "req_uri" : "/test/function", "req_method" : "GET", "match_mode" : "NORMAL", "duplicated_apis" : [ { "api_id" : "e25fcb255a664e80aa40759d37d043e9", "api_name" : "api_demo", "group_id" : "86d75a6b1d6c4cca99e1bed795074167", "group_name" : "DEFAULT", "api_type" : "self-owned" }, { "api_id" : "d41f91f14ecc476fa9bdef54afb37f06", "api_name" : "api_demo_duplicate", "group_id" : "c3053da9dcd54ffba3bf6e0fb7721a82", "group_name" : "EchoDemo", "api_type" : "self-owned" } ] } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_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"} 状态码： 404 Not Found { "error_code" : "APIG.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

应用与数据集成平台 ROMA Connect APP授权管理

应用与数据集成平台 ROMA Connect-查看APP下路径冲突的API列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiDuplicationInfo objects 应用下所有路径冲突的API信息列表表5 ApiDuplicationInfo 参数参数类型描述 req_method String 请求方式 req_uri String API的访问地址 match_mode String API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）默认：NORMAL duplicated_apis Array of DuplicateApiInfo objects 该路径下冲突的API列表表6 DuplicateApiInfo 参数参数类型描述 api_id String API ID api_name String API名称 group_name String 分组名称 group_id String 分组ID remark String API描述 api_type String API类型： self-owned：自有API authorized：授权API 状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表11 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

应用与数据集成平台 ROMA Connect APP授权管理

应用与数据集成平台 ROMA Connect-查看API已绑定的APP列表:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "auths" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "app_name" : "app_demo", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "envname" : "RELEASE", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_name" : "api_group_001", "api_type" : 1, "api_name" : "Api_http", "appid" : "356de8eb7a8742168586e5daf5339965", "auth_time" : "2020-08-04T04:02:22Z", "app_creator" : "USER", "id" : "dd29b33ae4394e3b924b582c6b40880b", "api_remark" : "Web Api", "auth_role" : "PROVIDER", "app_type" : "apig", "auth_tunnel" : "NORMAL" } ]} 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:app_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"} 状态码： 404 Not Found { "error_code" : "APIG.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"} 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}

应用与数据集成平台 ROMA Connect APP授权管理（V1）

应用与数据集成平台 ROMA Connect-查看API已绑定的APP列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths Array of V1ApiAuthInfo objects 本次返回的API列表表5 V1ApiAuthInfo 参数参数类型描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型： apig：存量apic客户端，新建实例不支持此类型 roma：roma集成客户端 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配，暂不支持 publish_id String API的发布编号 group_id String API绑定的分组ID auth_tunnel String 授权通道类型 NORMAL：普通通道 GREEN：绿色通道 auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_param String 访问参数。 roma_app_type String ROMA_APP的类型： subscription：订阅应用 integration：集成应用 envname String api授权绑定的环境 appid String APP的编号状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

应用与数据集成平台 ROMA Connect APP授权管理（V1）

云服务器内容精选

APP授权管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线