1)接口功能介绍
查询指定vpc网络的配置信息。
2)接口约束
无。
3)URI
GET /v1/describeNetworkAttribute。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpcId | 是 | String | 私有网络id | 1141 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 应答结果 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpcId | 是 | String | 私有网络id | 1141 | |
vpcName | 是 | String | 私有网络名称 | eop-vpc | |
nodeCode | 是 | String | 边缘池id | yn-lincahng-1 | |
vswitchInfos | 是 | Object | 虚拟交换机信息 | vswitchInfos | |
cidrBlock | 是 | String | IPv4网段 | 10.0.0.0/8 | |
state | 是 | String | 私有网络状态,VPC_ACTIVE:启用,VPC_DELETING:删除中,VPC_CREATING:创建中 | VPC_ACTIVE |
表 vswitchInfos
参数 | 是否必填 | 参数类型 | 示例值 | 说明 | 下级对象 |
---|---|---|---|---|---|
vSwitchId | 是 | String | 虚拟交换机id | 1427 | |
vSwitchName | 是 | String | 虚拟交换机名称 | eop-subnet | |
createTime | 是 | String | 虚拟交换机创建时间(Unix时间戳,秒) | 1610522930 | |
cidrBlock | 是 | String | 网络的IPv4网段 | 10.0.0.0 | |
gateway | 是 | String | 网关ip | 10.0.11.1 | |
instanceInfoDetails | 是 | Object | 可用虚拟机实例列表 | instanceInfoDetails | |
availableIPCount | 是 | Integer | 虚拟交换机内可用ip数量 | 251 | |
nodeCode | 是 | String | 边缘池id | yn-lincahng-1 | |
vpcId | 是 | String | 私有网络id | 1141 | |
vSwitchState | 是 | String | 虚拟交换机状态,VPC_ACTIVE:启用,VPC_DELETING:删除中,VPC_CREATING:创建中 | VSWITCH_ACTIVE | |
routeTableId | 是 | String | 路由表id | 3564 |
表 instanceInfoDetails
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
virtualMachineId | 否 | String | 实例ID | evm-xxxxxxx | |
virtualMachineName | 否 | String | 实例名称 | evm-xxxx |
6)请求示例
GET https://{host}/v1/describeNetworkAttribute?vpcId=1094
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"vpcId": "1094",
"nodeCode": "yn-lincang-1",
"vswitchInfos": [
{
"vSwitchName": "subnet-test",
"routeTableId": "1098",
"availableIPCount": 249,
"nodeCode": "yn-lincang-1",
"createTime": "1668584641",
"vpcId": "1094",
"vSwitchId": "1374",
"vSwitchState": "VSWITCH_ACTIVE",
"cidrBlock": "10.0.0.0/24",
"gateway": "10.0.0.1",
"instanceInfoDetails": [
{
"virtualMachineName": "gpu1",
"virtualMachineId": "evm-cdtf43f04suugak385ng"
},
{
"virtualMachineName": "abc",
"virtualMachineId": "evm-cdtf60v04suugak385rg"
},
{
"virtualMachineName": "New_name",
"virtualMachineId": "evm-cdtgf9f04suugak385sg"
}
]
}
],
"state": "VPC_ACTIVE",
"vpcName": "vpc-test",
"cidrBlock": "10.0.0.0/8"
},
"requestId": "2b5e63a6-9076-4727-96d0-d959e5482198"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |