查询CDA网络实例
更新时间 2025-08-01 18:58:36
最近更新时间: 2025-08-01 18:58:36
查询CDA网络实例
接口功能介绍
查询CDA网络实例
接口约束
无
URI
GET /v4/ec/cda-instance/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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 | |
| queryContent | 否 | String | 模糊匹配，支持云专线ID，实例ID，云企业路由器ID三个属性 | nm8CTYUN31 | |
| rtbType | 否 | Integer | 筛选路由表类型，不筛选则不传 取值包括： 1:默认 2:自定义 |
2 | |
| isAuth | 否 | Integer | 是否是跨账号授权的cda实例 取值包括： 0:本账号 1:跨账号 |
0 |
请求参数
请求头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 | 指定网络实例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 | |
| rtbID | 否 | String | 路由表ID | 5634d3c5-3533-4258-bb80-0a1805b643ea | |
| rtbName | 否 | String | 路由表名称 | default-route-table-gateway-8be8 | |
| cgwID | 否 | String | 云企业路由器ID | 11200584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwName | 否 | String | 云企业路由器名称 | gateway_beijing | |
| dcID | 否 | String | 资源池ID信息 | 81f7728662dd11ec810800155d307d5b | |
| dcName | 否 | String | 资源池名称 | 内蒙演示环境 | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| cdaCidrV4List | 否 | Array of Strings | V4子网列表，值类型为String | ["172.1.15.6/24"] | |
| cdaCidrV6List | 否 | Array of Strings | V6子网列表，值类型为String | ["2001:da8:201:1512::a269:83a0/128"] | |
| status | 否 | String | 指定状态描述 取值包括： "creating"：加载中 "running"：已连接 "removing"：卸载中 "flushing"：路由待更新 "error"：失败 |
running | |
| rgID | 否 | String | 冗余组ID | 13ecc73d-19b5-4180-8cf5-bd3b8e83acab | |
| rgName | 否 | String | 冗余组名称 | Redund-group-ce83ce | |
| weights | 否 | Integer | 权重，专线默认50 | 60 | |
| cdaVni | 否 | Integer | 专线vni | 1004 | |
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云企业路由器自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云企业路由器路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 | |
| limitRate | 否 | Integer | 实例限速，设置实例限速的时候，必须打开自动组网功能 取值范围: >0:限速, 单位Mbps 0:不限速 |
10 |
请求示例
请求头url
/v4/ec/cda-instance/list?ecID=82c40584-fe8f-49b0-9e09-ef915caeee10&cgwID=cbc630c0-9175-4f08-ae00-020009e3b12d&cdaID=nm8CTYUN31&instanceID=123f8a86-8729-4e62-b2e4-f228bccba3ce&status=running&isAuth=0
请求头header
无
请求体body
无
响应示例
{
"traceID": "386ce617859d880b401a0544f42fdc09",
"description": "",
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"status": "running",
"isAuth": 0,
"routeLearn": 1,
"ecID": "deb097b5-a11c-4484-9525-7f7d40babc57",
"cdaVni": 900039,
"cgwName": "gateway-f45a",
"rgName": "",
"cdaID": "033679A806DA6BE0A934",
"rtbID": "286b9ccc-6b27-4707-ba1c-687f5d68607e",
"rgID": "",
"limitRate": 0,
"cdaCidrV4List": [
],
"cgwID": "6c3008c9-b7b5-4c6f-b62f-bd1b383f3237",
"cdaCidrV6List": [
],
"instanceID": "51efb039-05e9-449f-a682-e31451dea845",
"rtbName": "default",
"dcID": "81f7728662dd11ec810800155d307d5b",
"cdaName": "nmCTYUNvrf-test-hs5",
"weights": 50,
"dcName": "内蒙8",
"createDate": "2025-02-07 07:39:50",
"routeSync": 1
}
]
},
"errorCode": "",
"message": "Query CDA instance success",
"statusCode": 800
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.NetworksEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
