接口功能介绍
列表终端节点服务中转规则(反向访问规则)
接口约束
无
URI
GET /v4/vpce/list-endpoint-service-reverse-rule
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
endpointServiceID | String | 是 | 终端节点服务id | endpser-t3jqijb64e |
page | Integer | 否 | 分页参数 | 1 |
pageNo | Integer | 否 | 列表的页码,默认值为 1, 推荐使用该字段, page 后续会废弃 | 1 |
pageSize | Integer | 否 | 每页数据量大小 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
reverseRules | Array of Objects | 终端节点列表数据 | 见下表 |
totalCount | Integer | 总条数 | 1 |
totalPage | Integer | 总页数 | 1 |
currentCount | Integer | 总页数 | 1 |
表 reverseRules
名字 | 类型 | 说明 | 示例 |
---|---|---|---|
ID | String | 节点服务中转规则ID | |
endpointServiceID | String | 终端节点关联的终端节点服务 | |
endpointID | String | 节点id | |
transitIPAddress | String | 中转ip地址 | |
transitPort | Integer | 中转端口,1到65535 | 8080 |
protocol | String | TCP:TCP协议,UDP:UDP协议 | |
targetIPAddress | String | 目标ip地址 | |
targetPort | Integer | 目标端口,1到65535 | 9090 |
createdAt | String | 创建时间 | |
updatedAt | String | 更新时间 |
请求示例
GET /v4/vpce/list-endpoint-service-reverse-rule?regionID=81f7728662dd11ec810800155d307d5b&endpointServiceID=endpser-t3jqijb64e
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"ID": "endprule-yl8ytw4699",
"endpointServiceID": "endpser-t3jqijb64e",
"endpointID": "6442d4f9-c699-4305-a312-9d6c21d54e36",
"transitIPAddress": "192.168.4.12",
"transitPort": 8080,
"protocol": "TCP",
"targetIPAddress": "192.168.0.5",
"targetPort": 9090,
"createdAt": "2022-11-11T02:10:25Z",
"updatedAt": "2022-11-11T02:10:25Z"
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。