查询云专线信息列表
接口功能介绍
查询云专线信息列表
接口约束
无
URI
GET /v4/ec/cda/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
account | 是 | String | 用户账号(邮箱) | test@189.com | |
resourcePoolID | 是 | String | 资源池ID | 75a2ad0b-a4c6-4fb8-80f5-0cb08943f49f |
请求参数
请求头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
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
account | 否 | String | 用户账号 | test-001 | |
v4SubnetList | 否 | Array of Strings | V4子网列表,值类型为String | ["172.1.18.1/24"] | |
v6SubnetList | 否 | Array of Strings | V6子网列表,值类型为String | [] | |
cdaDescription | 否 | String | 描述信息 | crossnetwork description | |
resourcePoolID | 否 | String | 资源池ID | 75a2ad0b-a4c6-4fb8-80f5-0cb08943f49f | |
resourcePoolName | 否 | String | 资源池名称 | 北京5 | |
cdaUUID | 否 | String | 专线唯一ID | 124aad0b-a4c6-4fb8-80f5-0cb08943f49f | |
cdaName | 否 | String | 专线名称 | cda-test-nm8 | |
vpcList | 否 | List of Objects | 专线加入的vpc列表 | vpcInfo | |
isUsed | 否 | Boolean | 是否使用,值类型为boolean | false |
表 vpcInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpcID | 否 | String | vpc ID | vpc-6tbrux7712 | |
vpcName | 否 | String | vpc名称 | vpc-35ac |
请求示例
请求url
/v4/ec/cda/list?account=test@189.com&resourcePoolID=75a2ad0b-a4c6-4fb8-80f5-0cb08943f49f
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"account": "test-001",
"v4SubnetList": ["172.1.18.1/24"],
"v6SubnetList": [],
"cdaDescription": "crossnetwork description",
"resourcePoolID": "75a2ad0b-a4c6-4fb8-80f5-0cb08943f49f",
"resourcePoolName": "\u5317\u4eac5",
"cdaUUID": "124aad0b-a4c6-4fb8-80f5-0cb08943f49f",
"cdaName":"cda-test-nm8",
"vpcList":[{
"vpcID": "vpc-6tbrux7712",
"vpcName": "vpc-35ac"
}],
"isUsed": false
}]
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.CDAEc.AccessFailed | 内部错误,请重试。如果多次尝试失败,请提交工单 |