1)接口功能介绍
查看虚拟交换机信息。
2)接口约束
请求边缘池id为必填,只返回有效的子网列表信息。
3)URI
GET /v1/describeVSwitch。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | yn-lincang-1 | |
vSwitchId | 否 | String | 虚拟交换机id,不填默认返回所有有效的子网信息 | 12 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 应答结果 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vSwitchDescs | 是 | Object | 虚拟交换机信息列表 | vSwitchDescs |
表 vSwitchDescs
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vSwitchId | 是 | String | 虚拟交换机id | eop-switche | |
vSwitchName | 是 | String | 虚拟交换机名称 | eop-switche | |
availableIPCount | 是 | Integer | 虚拟交换机内可用ip数量 | 251 | |
createTime | 是 | String | vpc创建时间(Unix时间戳,秒) | 1610522930 | |
nodeCode | 是 | String | 边缘集群id | yn-lincang-1 | |
gateway | 是 | String | 网关ip | 192.168.0.1 | |
vpcId | 是 | String | 私有网络ip | 1142 | |
vSwitchState | 是 | String | 虚拟交换机状态. VPC_ACTIVE:启用,VPC_DELETING:删除中,VPC_CREATING:创建中 | VPC_ACTIVE | |
cidrBlock | 否 | String | 网络的IPv4网段 | 10.0.0.0/24 | |
instanceInfoDetails | 是 | Object | 可用虚拟机实例列表 | instanceInfoDetails |
表 instanceInfoDetails
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
virtualMachineId | 否 | String | 实例ID | evm-xxxxxxx | |
virtualMachineName | 否 | String | 实例名称 | evm-xxxx |
6)请求示例
GET https://{host}/v1/describeVSwitch?nodeCode=yn-lincang-1&vSwitchId=1434
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vSwitchDescs": [
{
"vSwitchName": "subnet-3ce4",
"routeTableId": "",
"availableIPCount": 253,
"nodeCode": "yn-lincang-1",
"createTime": "1669551305",
"vpcId": "1145",
"vSwitchId": "1434",
"vSwitchState": "VSWITCH_ACTIVE",
"cidrBlock": "10.0.0.0/24",
"gateway": "10.0.0.1",
"instanceInfoDetails": []
}
]
},
"requestId": "c6f9a1fc-0b60-475f-b13b-cc633780ac91"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |