接口描述
您可以通过该接口查询虚拟交换机相关信息。
请求头
参数名称 |
类型 |
是否必须 |
描述 |
X-Version |
String |
是 |
版本号,取值:2020-08-01 |
X-Action |
String |
是 |
操作接口名,取值:DescribeVSwitchs |
请求参数
参数名称 |
类型 |
是否必须 |
示例值 |
描述 |
NamespaceId |
String |
是 |
default-UID |
命名空间ID |
VpcId |
String |
是 |
458f4e89-6be0-4303-a31c-280895c07658 |
VPCID |
VSwitchId |
String |
是 |
458f4e89-6be0-4303-a31c-280895c07659 |
VSwitchId |
返回参数
参数名称 |
类型 |
示例值 |
描述 |
RequestID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
请求ID |
Code |
String |
Success |
状态码,有InvalidParameter,Forbidden InternalError,Success四种状态 |
VSwitchs |
Array |
|
交换机列表 |
VSwitchs
参数名称 |
类型 |
示例值 |
描述 |
VSwitchId |
String |
b16e782d-6689-4ac5-9478-9b32fbd0709d |
交换机的ID |
VSwitchName |
String |
kenc_vswitch |
vswitch名称 |
VpcId |
String |
458f4e89-6be0-4303-a31c-280895c07658 |
VPC虚拟网络ID |
CidrBlock |
String |
172.16.0.0/12 |
交换机的网段 |
Description |
String |
- |
交换机描述 |
AvailableIpAddressCount |
Long |
1 |
交换机中可用的IP地址余量。 |
CreateTime |
String |
2018-01-18T12:43:57Z |
交换机的创建时间。 |
NetworkAclId |
String |
111 |
网络ACL ID |
请求示例
入参示例
curl --location --request GET 'kenc.api.ksyun.com?NamespaceId=demo&VpcId=4a70ee3b-9a6e-4ae9-a982-1134d6ec1614' \
--header 'X-Action: DescribeVSwitchs' \
--header 'X-Version: 2020-08-01' \
--header 'X-Amz-Date: 20210517T025443Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTTCrDNnS2S2iHLvz_zawSMg/20210517/beijing-6/kenc/aws4_request, SignedHeaders=host;x-amz-date, Signature=xxxxxxxxxx'
成功示例
{
"Code": "Success",
"RequestId": "3a87cc31-efe6-487c-b28b-11bec3571e7d",
"VSwitchs": [
{
"VSwitchId": "823933cb-daa1-46a6-b458-f224921e5fc9",
"VSwitchName": "kenc_vswitch",
"VpcId": "4a70ee3b-9a6e-4ae9-a982-1134d6ec1614",
"CidrBlock": "172.16.0.0/28",
"AvailableIpAddressCount": 12,
"Description": "",
"CreateTime": "2021-05-17T11:09:15+08:00",
"NetworkAclId": ""
}
]
}
失败示例
{
"RequestId": "22a9015d-fd66-45a7-b82e-8e01d39ad94e",
"Code": "InvalidParameter",
"Message": "Invalid param NamespaceId."
}