查询CDA网络实例
接口功能介绍
查询CDA网络实例
接口约束
无
URI
POST /v4/ec/cda-instance/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | cbc630c0-9175-4f08-ae00-020009e3b12d | |
| cdaID | 否 | String | 云专线ID | nm8CTYUN31 | |
| instanceID | 否 | String | 指定网络实例ID | 123f8a86-8729-4e62-b2e4-f228bccba3ce | |
| status | 否 | String | 指定状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "flushing"：路由待更新 "error"：失败 |
running | |
| isAuth | 否 | Integer | 是否是跨账号授权的cda实例 取值包括： 0:本账号 1:跨账号 |
0 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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 | 指定网络实例ID | 123f8a86-8729-4e62-b2e4-f228bccba3ce | |
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cdaID | 否 | String | 云专线ID | 11200584-fe8f-49b0-9e09-ef915caeee10 | |
| cdaName | 否 | String | 云专线名称 | cda-test | |
| defaultRtbID | 否 | String | 云网关默认路由表ID | 66720584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | 11200584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwName | 否 | String | 云网关名称 | gateway_beijing | |
| weights | 否 | Integer | 权重，专线默认50 | 60 | |
| redundantType | 否 | Integer | 冗余类型 取值包括 1：主备 2：负载 0：无 |
1 | |
| redundantInstUUID | 否 | String | 冗余负载实例的UUID | 11200584-fe8f-49b0-9e09-ef915caeee10 | |
| redundantInstName | 否 | String | 冗余负载实例的名称 | red-instance | |
| redundantInstType | 否 | String | 冗余负载实例的类型 取值包括 2: 云专线 3: sdwan 4: vpn |
11200584-fe8f-49b0-9e09-ef915caeee10 | |
| redundantInstID | 否 | String | 冗余负载侧ID，即当前为cdaID, sdwanID，vpnID | red-instance | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| v4SubnetList | 否 | Array of Strings | V4子网列表，值类型为String | ["172.1.15.6/24"] | |
| v6SubnetList | 否 | Array of Strings | V6子网列表，值类型为String | [] | |
| routeTableName | 否 | String | 路由表名称 | default | |
| status | 否 | String | 指定状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "flushing"：路由待更新 "error"：失败 |
running | |
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 |
请求示例
请求头header
请求体body
{
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "cbc630c0-9175-4f08-ae00-020009e3b12d",
"cdaID": "nm8CTYUN31",
"instanceID": "123f8a86-8729-4e62-b2e4-f228bccba3ce",
"status": "running",
"isAuth":0
}
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"instanceID": "123f8a86-8729-4e62-b2e4-f228bccba3ce",
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cdaID": "11200584-fe8f-49b0-9e09-ef915caeee10",
"cdaName" :"cda-test",
"defaultRtbID": "66720584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "gateway_beijing",
"cgwName": "gateway_beijing",
"weights": 50,
"redundantType" : 0,
"redundantInstUUID":"",
"redundantInstName":"",
"redundantInstType":"",
"redundantInstID":"",
"createDate": "2022-09-19 02:05:28",
"v4SubnetList": ["172.1.15.6/24"],
"v6SubnetList": [],
"routeTableName":"default",
"status": "running",
"isAuth":0,
"routeLearn":1,
"routeSync":1
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
