查询跨域连接
接口功能介绍
查询跨域连接
接口约束
无
URI
GET /v4/ec/region-peer/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| packetID | 否 | String | 带宽包ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| cgwID | 否 | String | 云网关ID，传则查询包含该云网关的跨域连接 | 8a8bccsa-4e62-8729-b2e4-cba3cf228bce |
请求参数
请求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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| peerID | 否 | String | 跨域连接ID | a43f8a86-8729-4e62-b2e4-f228bccba3ce | |
| peerName | 否 | String | 跨域连接名称 | peer-test | |
| srcCgwID | 否 | String | 本端网关ID | 81f7728662dd11ec810800155d307d5b | |
| dstCgwID | 否 | String | 对端网关ID | 32a317583ea811eb8e2d0242ac110004 | |
| srcCgwName | 否 | String | 本端网关名称 | 贵州6网关1 | |
| dstCgwName | 否 | String | 对端网关名称 | 内蒙8网关1 | |
| srcDcID | 否 | String | 本端资源池ID | 81f7728662dd11ec810800155d307d5b | |
| dstDcID | 否 | String | 对端资源池ID | 728662dd11ec810800155d307d5badfe | |
| srcDcName | 否 | String | 本端资源池名称 | 内蒙8 | |
| dstDcName | 否 | String | 对端资源池名称 | 贵州5 | |
| peerType | 否 | Integer | 互通类型，取值如下： 1: 境内 2: 跨境（中国大陆-亚太） 3: 境外（亚太） 4: 定制 |
1 | |
| ecID | 否 | String | 云间高速ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| packetID | 否 | String | 带宽包ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| packetName | 否 | String | 带宽包名称 | packet01 | |
| rate | 否 | Integer | 带宽值（MB） | 10 | |
| status | 否 | String | 状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "expired"：过期 |
running | |
| updateDate | 否 | String | 更新时间 | 2022-09-19 02:05:28 |
请求示例
请求url
v4/ec/region-peer/list?ecID=5000948f-f9ba-4482-83fa-81cc7d0e5171
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"peerID": "a43f8a86-8729-4e62-b2e4-f228bccba3ce",
"peerName":"peer-test",
"srcCgwID": "81f7728662dd11ec810800155d307d5b",
"dstCgwID": "32a317583ea811eb8e2d0242ac110004",
"srcCgwName": "\u8d35\u5dde6\u7f51\u51731",
"dstCgwName": "\u5185\u84998\u7f51\u51731",
"srcDcID":"81f7728662dd11ec810800155d307d5b",
"dstDcID":"728662dd11ec810800155d307d5badfe",
"srcDcName":"内蒙8",
"dstDcName":"贵州5",
"peerType":1,
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"packetID": "7c84cfa9-a997-4281-af8a-3c765c25d0be",
"packetName": "packet01",
"rate": 10,
"status": "running",
"updateDate":"2022-09-19 02:05:28"
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.RegionPeerEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
