接口功能介绍
查询对等连接列表。
接口约束
无。
URI
GET /v4/vpc/list-vpc-peer-connection
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| pageSize | Integer | 否 | 当前页数据条数 | 10 |
| pageNumber | Integer | 否 | 当前页 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| regionID | String | 是 | 区域id | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| descritption | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| requestVpcID | String | 本端vpc Id值 | |
| requestVpcName | String | 本端vpc的名称 | |
| requestVpcCidr | String | 本端vpc的网段 | |
| acceptVpcID | String | 对端的vpc Id值 | |
| acceptVpcName | String | 对端vpc的名称 | |
| acceptVpcCidr | String | 对端vpc的网段 | |
| acceptEmail | String | 对端vpc账户的邮箱 | |
| userType | String | 对等连接类型：current(同一个租户) / other(不同租户) | |
| name | String | 对等连接名称 | |
| instanceID | String | 对等连接 ID | |
| status | String | 对等连接状态：agree(同意建立对等连接) / pending(待同意建立对等连接) | agree |
请求示例
GET /v4/vpc/list-vpc-peer-connection?regionID=81f7728662dd11ec810800155d307d5b
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"name": "rs-peer",
"instanceID": "vpr-73kphwv19a",
"status": "agree",
"requestVpcID": "vpc-6o0b32gus8",
"requestVpcCidr": null,
"requestVpcName": null,
"acceptVpcID": "vpc-pt1m783ym8",
"acceptVpcCidr": null,
"acceptVpcName": null,
"creationTime": "2022-06-20T13:01:22Z",
"userType": "xxx"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
