describeBackendConfigs
描述
查询指定环境下的所有后端配置
请求方式
GET
请求地址
https://apigateway.jdcloud-api.com/v1/regions/{regionId}/apiGroups/{apiGroupId}/environment/{environment}/backendConfigs
名称 |
类型 |
是否必需 |
默认值 |
描述 |
regionId |
String |
True |
|
地域ID |
apiGroupId |
String |
True |
|
分组ID |
environment |
String |
True |
|
环境:test、preview、online |
请求参数
名称 |
类型 |
是否必需 |
默认值 |
描述 |
pageNumber |
Integer |
False |
1 |
页码, 默认为1, 取值范围:[1,∞) |
pageSize |
Integer |
False |
20 |
分页大小,默认为20,取值范围:[10,100] |
filters |
Filter[ ] |
False |
|
sort - 路由排序,赋值0时为默认的后端配置
|
Filter
名称 |
类型 |
是否必需 |
默认值 |
描述 |
name |
String |
True |
|
过滤条件的名称 |
operator |
String |
False |
|
过滤条件的操作符,默认eq |
values |
String[ ] |
True |
|
过滤条件的值 |
返回参数
名称 |
类型 |
描述 |
result |
Result |
查询结果集 |
requestId |
String |
请求ID |
Result
BackendConfig
名称 |
类型 |
描述 |
backendConfigId |
String |
接口ID |
baseGroupId |
String |
分组ID |
environment |
String |
环境:test、preview、online |
backendUrl |
String |
后端地址 |
backendServiceType |
String |
后端服务类型:mock、HTTP/HTTPS |
headerParams |
SimpleParameter[ ] |
header参数列表 |
queryParams |
SimpleParameter[ ] |
query参数列表 |
description |
String |
描述 |
createTime |
Long |
发布日期,格式为毫秒级时间戳 |
sort |
Integer |
排序,赋值0时为默认的后端配置 |
userSort |
Integer |
排序,用于展示使用 |
jdsfId |
String |
vpc网关id |
jdsfParam |
String |
vpc后端地址 |
jdsfRegion |
String |
vpc网关所属region |
jdsfPin |
String |
vpc网关创建者的pin |
SimpleParameter
名称 |
类型 |
描述 |
name |
String |
名称 |
value |
String |
值 |
返回码
返回码 |
描述 |
200 |
OK |
400 |
Invalid parameter |
401 |
Authentication failed |
500 |
Internal server error |
503 |
Service unavailable |