查询EDS网络实例详情
接口功能介绍
查询指定EDS网络实例详情
接口约束
无
URI
GET /v4/ec/eds-instance/get
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 是 | String | 云网关ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| instanceID | 是 | String | eds实例的UUID | bc9a70eb-28d7-4032-9510-1bea00192f34 |
请求参数
请求头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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| instanceID | 否 | String | eds实例的UUID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| ecID | 否 | String | 云间高速ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| status | 否 | String | 指定状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "flushing"：路由待更新 "error"：失败 |
running | |
| vpcID | 否 | String | vpc ID | vpn-gateway-b3d4 | |
| vpcName | 否 | String | vpc名称 | vpn-001 | |
| dcID | 否 | String | 资源池ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| rtbID | 否 | String | 路由表ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| rtbName | 否 | String | 路由表名称 | default | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| subnets | 否 | Array of Objects | eds子网信息 | subnet | |
| isAuth | 否 | Integer | 实例类型是否是授权账号 取值范围: 1:授权 0:非授权 |
0 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 |
表 subnet
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnetName | 否 | String | 子网名称 | 165bc766 | |
| subnetID | 否 | String | 子网ID | id-subnet | |
| IPVersion | 否 | String | 子网类型 取值范围: "IPV4":IPv4类型 "IPV6":IPv6类型 |
||
| CIDR | 否 | String | 网络实例CIDR | 192.168.0.0/16 |
请求示例
请求url
v4/ec/eds-instance/get?ecID=6949e4e6-8f92-4b05-8cae-b3977914f15b&cgwID=bb6669fd-06c1-4022-9cb4-615a90d65798&instanceID=3eebfdb0-9c05-4574-bfb1-c530dad9b896
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"instanceID": "3eebfdb0-9c05-4574-bfb1-c530dad9b896",
"ecID": "169b89b8-0d5f-4908-85b1-880f1fe50601",
"cgwID": "bb6669fd-06c1-4022-9cb4-615a90d65798",
"cgwName": "nm8",
"status": "running",
"vpcID": "vpnCTYUN456",
"vpcName":"vpn-22j4",
"dcID": "437d7519-5bde-4fc8-86ea-d403e82f7544",
"rtbID": "437d7519-5bde-4fc8-86ea-d403e82f7544",
"rtbName": "default-route-table-nm8",
"createDate": "2023-07-27 12:00:11",
"subnets": [{
"subnetName": "subnet-5qh3",
"subnetID": "f69c6512-e4cc-4c42-8fa5-8238abcee2d4",
"ipVersion": "IPV4",
"cidr": "172.16.151.0/24"
}, {
"subnetName": "subnet-bbst",
"subnetID": "f69c6512-e4cc-4c42-8fa5-8238abcee2d4",
"ipVersion": "IPV4",
"cidr": "172.16.150.0/24"
}],
"isAuth":0,
"routeSync":1,
"routeLearn":1
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
