接口功能介绍
查看终端节点服务列表
接口约束
无
URI
GET /v4/vpce/list-endpoint-service
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
page | Integer | 否 | 分页参数 | 1 |
pageNo | Integer | 否 | 列表的页码,默认值为 1, 推荐使用该字段, page 后续会废弃 | 1 |
pageSize | Integer | 否 | 每页数据量大小 | 10 |
id | String | 否 | 节点服务id | endpser-9hzaohgug8 |
endpointServiceName | String | 否 | 终端节点服务名称,该字段为精确匹配 | test |
queryContent | String | 否 | 支持对终端节点服务名称进行模糊匹配 | tes |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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 | 接口业务数据 | 见下表 |
totalCount | Integer | 总条数 | 1 |
totalPage | Integer | 总页数 | 1 |
currentCount | Integer | 总页数 | 1 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
ID | String | 终端节点服务ID | endpser-4bz2ogmq11 |
name | String | 终端节点服务名称 | szyy2 |
vpcID | String | 所属的专有网络id | vpc-srsiebllhc |
description | String | 描述 | |
type | String | 接口还是反向,interface:接口,reverse:反向 | interface |
autoConnection | Boolean | 是否自动连接 | true |
rules | Array of Objects | 接口规则数据 | 见下表 |
backends | Array of Objects | 后端数据 | 见下表 |
createdAt | String | 创建时间 | 2022-10-24T01:20:06Z |
updatedAt | String | 更新时间 | 2022-10-24T01:20:06Z |
表 rule
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
protocol | String | 协议,TCP:TCP协议,UDP:UDP协议 | TCP |
serverPort | Integer | 服务端口(用于创建backend传入) | 100 |
endpointPort | Integer | 节点端口(用于创建rule传入) | 100 |
表 backend
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
instanceType | String | vm:虚机类型,bm:智能网卡类型,vip:vip类型,lb:负载均衡类型 | lb |
instanceID | String | 实例id | lb-tfa20qb11w |
protocolPort | Integer | 端口 | 100 |
weight | Integer | 权重 | 50 |
请求示例
GET /v4/vpce/list-endpoint-service?regionID=81f7728662dd11ec810800155d307d5b
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"ID": "endpser-4bz2ogmq11",
"name": "szyy2",
"vpcID": "vpc-srsiebllhc",
"description": "aaa",
"type": "interface",
"autoConnection": true,
"rules": [
{
"protocol": "TCP",
"serverPort": 100,
"endpointPort": 100,
}
],
"backends": [
{
"instanceType": "lb",
"instanceID": "lb-tfa20qb11w",
"protocolPort": 100,
"weight": 50
}
],
"createdAt": "2022-10-24T01:20:06Z",
"updatedAt": "2022-10-24T01:20:06Z"
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。