查询云网关
接口功能介绍
查询已创建的云网关
接口约束
无
URI
GET /v4/ec/cloud-gateway/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关实例ID | f414b38e-e60f-4b5c-b3c9-bc4e9e50c9ad | |
| queryContent | 否 | String | 模糊匹配，支持cgwID,cgwName,cgwDescription三个属性 | cgwDescription | |
| region | 否 | String | 地域信息，不填默认查询全部 取值如下 1:中国大陆 2:亚太 |
1 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表 results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cgwID | 否 | String | 云网关实例ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| region | 否 | Integer | 地域信息，不填默认查询全部 取值如下 1：中国大陆 2:亚太 |
1 | |
| cgwName | 否 | String | 云网关名称 | gateway_beijing | |
| cgwDescription | 否 | String | 云网关描述 | 北京云网关 | |
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| dcID | 否 | String | 资源池ID信息 | 81f7728662dd11ec810800155d307d5b | |
| dcType | 否 | String | 资源池类型， 取值范围: "CNP":CNP资源池 "MAZ":MAZ资源池 |
MAZ | |
| dcName | 否 | String | 资源池名称 | 内蒙演示环境 | |
| rtbCnt | 否 | Integer | 路由表数量 | 2 | |
| routeCnt | 否 | Integer | 路由数量 | 2 | |
| policyCount | 否 | Integer | 流量策略数量 | 2 | |
| insCnt | 否 | Integer | 连接实例数量 | 2 | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| defaultRtbID | 否 | String | 云网关默认路由表ID | 66720584-fe8f-49b0-9e09-ef915caeee10 | |
| hasMonitor | 否 | Bool | 是否支持监控 true:支持，false:不支持 |
false |
请求示例
请求url
/v4/ec/cloud-gateway/list?ecID=82c40584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"region": 1,
"cgwName": "gateway_beijing",
"cgwDescription": "\u5317\u4eac\u4e91\u7f51\u5173",
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"dcID": "81f7728662dd11ec810800155d307d5b",
"dcType": "MAZ",
"dcName": "\u5185\u8499\u6f14\u793a\u73af\u5883",
"rtbCnt": 2,
"routeCnt":2,
"policyCount":0,
"hasMonitor":true,
"insCnt": 2,
"createDate": "2022-09-19 02:05:28",
"defaultRtbID": "66720584-fe8f-49b0-9e09-ef915caeee10"
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.CloudGatewayEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
