查询VPN实例数量
接口功能介绍
查询已加载到云间高速的VPN实例数量,支持统计云间高速维度和云网关维度的所有VPN实例数量。
接口约束
无
URI
GET /v4/ec/vpn-instance/count
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ecID | 是 | String | 云间高速ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
cgwID | 否 | String | 云网关ID | bc9a70eb-28d7-4032-9510-1bea00192f34 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpnCount | 否 | Integer | vpc实例数量 | 3 |
请求示例
请求url
v4/ec/vpn-instance/count
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"vpnCount": 1
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.NetworksEc.AccessFailed | 内部错误,请重试。如果多次尝试失败,请提交工单 |