接口描述
您可以通过该接口查询虚拟私有网络的信息。
请求头
参数名称 |
类型 |
是否必须 |
描述 |
X-Version |
String |
是 |
版本号,取值:2020-08-01 |
X-Action |
String |
是 |
操作接口名,取值:DescribeVpcs |
请求参数
参数名称 |
类型 |
是否必须 |
示例值 |
描述 |
NamespaceId |
String |
是 |
default-UID |
命名空间ID |
EdgeNodeId |
String |
是 |
jnun11 |
边缘节点ID |
VpcIds |
String |
是 |
458f4e89-6be0-4303-a31c-280895c07658 |
虚拟私有网络ID,如需查询多个实例,以 , 分隔; |
返回参数
参数名称 |
类型 |
示例值 |
描述 |
RequestID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
请求ID |
Code |
String |
Success |
状态码,有InvalidParameter,Forbidden InternalError,Success四种状态 |
Vpcs |
Array |
|
VPC列表 |
Vpcs
参数名称 |
类型 |
示例值 |
描述 |
VpcId |
String |
458f4e89-6be0-4303-a31c-280895c07658 |
虚拟私有网络ID |
VpcName |
String |
kenc_vpc |
vpc名称,命名规则为:长度为2~128个英文或中文字符;必须以大小写字母或中文开头;可以包含数字、下划线(_)、英文句号(.)或者连字符(-)。如果没有指定该参数,默认值为kenc_vpc |
EdgeNodeId |
String |
jnun11 |
边缘节点ID |
CreateTime |
String |
2020-08-31T17:43:00Z |
Vpc创建时间,按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。 |
CidrBlock |
String |
192.168.0.0/16 |
VPC的IPv4网段。 |
Description |
String |
- |
虚拟网络描述。规则为长度不大于128个英文或中文字符;如果没有指定该参数,默认值为空 |
VSwitchs |
Array |
|
交换机列表 |
NetworkAcls |
Array |
|
网络ACL列表 |
LoadBalances |
Array |
|
负载均衡列表 |
SecurityGroups |
Array |
|
安全组列表 |
Instances |
Array |
|
实例列表 |
VSwitchs
参数名称 |
类型 |
示例值 |
描述 |
VSwitchId |
String |
vsw-25bcdxs7 |
交换机的ID |
NetworkAcls
参数名称 |
类型 |
示例值 |
描述 |
NetworkAclId |
String |
458f4e89-6be0-4303-a31c-280895c07658 |
网络ACL ID |
LoadBalances
参数名称 |
类型 |
示例值 |
描述 |
LoadBalanceId |
String |
458f4e89-6be0-4303-a31c-280895c07658 |
负载均衡器ID |
SecurityGroups
参数名称 |
类型 |
示例值 |
描述 |
SecurityGroupId |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
安全组ID |
Instances
参数名称 |
类型 |
示例值 |
描述 |
InstanceId |
String |
i-9147f8d6bd69d65b43fbeab3da5ed9621-sxct01 |
实例ID |
请求示例
入参示例
curl --location --request GET 'kenc.api.ksyun.com?EdgeNodeId=qajncm21&NamespaceId=demo' \
--header 'X-Action: DescribeVpcs' \
--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",
"Vpcs": [
{
"VpcId": "0051d63b-a3b7-4690-b58a-96df7c905d6d",
"VpcName": "vpc_1",
"EdgeNodeId": "qajncm21",
"CreateTime": "2021-05-14T09:45:32+08:00",
"CidrBlock": "192.168.10.0/24",
"Description": "",
"VSwitchs": [
{
"VSwitchId": "6fe6f1b6-e5ee-4edd-8c93-fa857de07402"
},
{
"VSwitchId": "9587962b-735b-4202-b11f-ec5be2bfc237"
},
{
"VSwitchId": "ca5b3bcc-faf4-46f1-a23d-be7887487096"
}
],
"NetworkAcls": [
{
"NetworkAclId": "97dc7902-fdbd-4dd9-98bb-d689a51601bf"
},
{
"NetworkAclId": "6629d9d2-ad56-41ac-a0f9-6435c8830eba"
}
],
"LoadBalances": [ ],
"SecurityGroups": [
{
"SecurityGroupId": "3fcb2ab9-3fd6-4a1b-8008-f891ed9ec156"
},
{
"SecurityGroupId": "00ea180f-6f72-4989-82b1-be50a42c78ca"
}
],
"Instances": [
{
"InstanceId": "i-dce22552170811a05d2ebcf3a47ab0be-qajncm21"
}
]
}
]
}
失败示例
{
"RequestId": "22a9015d-fd66-45a7-b82e-8e01d39ad94e",
"Code": "InvalidParameter",
"Message": "Invalid param NamespaceId."
}