接口功能介绍
查询应用接入点列表
接口约束
无
URI
POST /v1/applicationAccessPointManage/listApplicationAccessPoint
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNum | 否 | Integer | 当前页码 | 1 | |
pageSize | 否 | Integer | 页码大小 | 10 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 状态码 取值范围:200 成功 | 200 | |
message | 是 | String | 提示信息 | Success | |
returnObj | 是 | Object | 返回数据结构体 | {} | result |
error | 否 | String | 错误码 仅错误时返回 格式为{服务编码}.{错误编号} | KMS.0269 |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
list | 是 | Array of Objects | 应用接入点列表 | applicationList | |
totalCount | 是 | Integer | 总数量 | 5 | |
pageNum | 是 | Integer | 当前页码 | 1 | |
pageSize | 是 | Integer | 页码大小 | 10 |
表 applicationList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpcId | 是 | String | vpc id | vpc-r5ka3qk24m | |
subnetId | 是 | String | 子网id | subnet-6mojt0h30o | |
endpointId | 是 | String | 终端节点id | 96126272-5262-4b61-bf5c-d66ca3c7a0b3 | |
url | 是 | String | 接入地址 | http://192.168.11.8:9091 | |
vpcName | 是 | String | vpc名称 | vpc-cfw-user-test | |
subnetName | 是 | String | 子网名称 | subnet-cfw-server | |
applicationStatus | 是 | String | 接入点状态 | 1 | |
applicationId | 是 | String | 接入点id | 12345-89018 | |
applicationName | 是 | String | 接入点名称 | test | |
description | 是 | String | 接入点描述 | aaa |
枚举参数
参数名 applicationStatus
枚举值 | 类型 | 说明 |
---|---|---|
1 | String | 启用 |
2 | String | 创建中 |
0 | String | 冻结 |
-1 | String | 删除 |
-2 | String | 创建失败 |
请求示例
请求url
https://{host}/v1/applicationAccessPointManage/listApplicationAccessPoint
请求头header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"pageNum": 1,
"pageSize": 10
}
响应示例
{
"statusCode": 200,
"message": "获取vpce列表成功",
"returnObj": {
"pageSize": 10,
"list": [
{
"subnetId": "subnet-6mojt0h30o",
"vpcName": "vpc-cfw-user-test",
"endpointId": "96126272-5262-4b61-bf5c-d66ca3c7a0b3",
"vpcId": "vpc-r5ka3qk24m",
"subnetName": "subnet-cfw-server",
"url": "http://192.168.11.8:9091",
"applicationStatus": "1",
"applicationId": "12345-89018",
"applicationName": "test",
"description": "aaa"
}
],
"totalCount": 1,
"pageNum": 1
}
}
状态码
请参考状态码章节
错误码
请参考错误码章节