接口功能介绍
查看终端节点详情
接口约束
无
URI
GET /v4/vpce/show-endpoint
请求参数
Query 参数
| 参数 |
参数类型 |
是否必填 |
说明 |
示例 |
| regionID |
String |
是 |
资源池ID |
81f7728662dd11ec810800155d307d5b |
| endpointID |
String |
是 |
终端节点 ID |
endpoint-xxx |
响应参数
| 参数 |
参数类型 |
说明 |
示例 |
| statusCode |
Integer |
返回状态码（800为成功，900为失败） |
800 |
| message |
String |
statusCode为900时的错误信息; statusCode为800时为success, 英文 |
success |
| description |
String |
statusCode为900时的错误信息; statusCode为800时为成功, 中文 |
成功 |
| errorCode |
String |
statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
SUCCESS |
| returnObj |
Object |
接口业务数据 |
见下表 |
表 returnObj
| 参数 |
参数类型 |
说明 |
示例 |
| endpoint |
Object |
终端节点列表数据 |
见下表 |
表 endpoint
| 参数 |
参数类型 |
说明 |
示例 |
| ID |
String |
终端节点ID |
a2009322-41db-466d-bd32-01ff51bff327 |
| endpointServiceID |
String |
终端节点服务ID |
fab93dbd-84ba-4b07-a55d-c6f5d5789b27 |
| type |
String |
接口还是反向，interface:接口，reverse:反向 |
interface |
| name |
String |
终端节点名称 |
endpoint name |
| vpcID |
String |
所属的专有网络id |
vpc-xxxx |
| vpcAddress |
String |
私网地址 |
192.168.1.1 |
| whitelist |
String |
白名单 |
10.150.0.0/24,10.150.0.0/25 |
| status |
Integer |
endpoint状态, 1 表示已链接，2 表示未链接 |
1 |
| description |
String |
描述 |
null |
| endpointObj |
Object |
后端节点信息，可能为 null |
null |
| createdTime |
String |
创建时间 |
2022-07-07T09:29:55Z |
| updatedTime |
String |
更新时间 |
2022-10-12T08:15:57Z |
表 endpointObj
| 参数 |
参数类型 |
说明 |
示例 |
| subnetID |
String |
子网id |
subnet-whm7dbxzki |
| portID |
String |
端口id |
port-hgoj5cy8d6 |
| ip |
String |
私网地址 |
192.168.1.1 |
| enableDns |
Integer |
是否开启 dns |
0 |
| dnsNames |
Array of String |
dns名称列表 |
|
请求示例
GET /v4/vpce/show-endpoint?regionID=81f7728662dd11ec810800155d307d5b&endpointID=endpoint-tmncs8h97b
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"endpoint": {
"ID": "a2009322-41db-466d-bd32-01ff51bff327",
"endpointServiceID": "fab93dbd-84ba-4b07-a55d-c6f5d5789b27",
"type": "interface",
"name": "test",
"vpcID": "vpc-bxlui8nvd9",
"vpcAddress": "192.168.20.11",
"whitelist": "10.150.0.0/24,10.150.0.0/25",
"status": 1,
"description": null,
"endpointObj": {
"subnetID": "subnet-whm7dbxzki",
"portID": "port-hgoj5cy8d6",
"ip": "192.168.20.11",
"enableDns": 0,
"dnsNames": [
""
]
},
"createdTime": "2022-07-07T09:29:55Z",
"updatedTime": "2022-10-12T08:15:57Z"
}
}
}
状态码
错误码
请参考 错误码说明。
