DescribeVpcAttribute - 查询指定VPC的配置信息 - 专有网络 VPC

查询指定VPC的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeVpcAttribute	get	*VPC `acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}`	vpc:tag	无

请求参数

名称	类型	必填	描述	示例值
VpcId	string	是	要查询的 VPC 的 ID。	vpc-bp18sth14qii3pnv****
RegionId	string	是	VPC 所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 2xx HTTP 状态码并直接查询资源状况。	false
IsDefault	boolean	否	是否为默认 VPC，取值： false（默认值）：不是默认 VPC。 true：是默认 VPC。	false

返回参数

名称	类型	描述	示例值
	object	VPC 的创建时间。
CreationTime	string	VPC 的创建时间。	2021-10-16T07:31:09Z
Status	string	VPC 的状态。取值： Available：可用。 Pending：配置中。	Available
VpcId	string	VPC 的 ID。	vpc-bp18sth14qii3pnvo****
IsDefault	boolean	是否是默认 VPC。取值： true：是默认 VPC。 false（默认值）：非默认 VPC。	false
ClassicLinkEnabled	boolean	是否开启了 ClassicLink 功能。取值： true：已开启。 false（默认值）：未开启。	false
OwnerId	long	VPC 所属的账号 ID。	28311773240248****
RegionId	string	VPC 所在的地域 ID。	cn-hangzhou
VpcName	string	VPC 的名称。	doctest2
VRouterId	string	VPC 的路由器 ID。	vrt-bp1jso6ng1at0ajsc****
DhcpOptionsSetStatus	string	DHCP 选项集的状态。取值： Available：可用。 InUse：使用中。 Deleted：已删除。 Pending：配置中。	Available
CidrBlock	string	VPC 的 IPv4 网段。	192.168.0.0/16
RequestId	string	请求 ID。	7486AE4A-129D-43DB-A714-2432C074BA04
Description	string	VPC 的描述。	VPC
ResourceGroupId	string	资源组 ID。	rg-acfmxazbvgb4ph****
DhcpOptionsSetId	string	DHCP 选项集的 ID。	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	VPC 的 IPv6 网段。	2408:XXXX:0:a600::/56
VSwitchIds	array	VPC 下的交换机列表。
VSwitchId	string	VPC 下的交换机列表。	{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
UserCidrs	array	用户侧网络的网段，如定义了多个网段，返回时会以半角逗号（,）隔开，最多支持 3 个网段。
UserCidr	string	用户侧网络的网段，如定义了多个网段，返回时会以半角逗号（,）隔开，最多支持 3 个网段。	172.16.0.1/24
SecondaryCidrBlocks	array	VPC 附加 IPv4 网段。
SecondaryCidrBlock	string	VPC 附加 IPv4 网段。	192.168.0.0/16
AssociatedCens	array<object>	绑定的云企业网列表。如果 VPC 未绑定云企业网，则不返回该参数。
AssociatedCen	object	云企业网所属账号的 ID。
CenOwnerId	long	云企业网所属账号的 ID。	28311773240248****
CenId	string	VPC 绑定的云企业网实例 ID。	cen-7qthudw0ll6jmc****
CenStatus	string	VPC 绑定云企业网的状态。仅 VPC 绑定了云企业网时返回 Attached。	Attached
CloudResources	array<object>	VPC 下的资源列表。
CloudResourceSetType	object	VPC 下的资源数量。
ResourceCount	integer	VPC 下的资源数量。	1
ResourceType	string	VPC 下的资源类型。取值： VSwitch：交换机。 VRouter：路由器。 RouteTable：路由表。	VSwitch
Ipv6CidrBlocks	array<object>	VPC 的 IPv6 网段信息。
Ipv6CidrBlock	object	VPC 的 IPv6 网段信息。
Ipv6Isp	string	VPC 的 IPv6 地址段类型。取值： BGP（默认值）：阿里云 BGP IPv6。 ChinaMobile：中国移动（单线）。 ChinaUnicom：中国联通（单线）。 ChinaTelecom：中国电信（单线）。说明如果是开通了单线带宽白名单的用户，该字段可以设置为 ChinaTelecom（中国电信）、ChinaUnicom（中国联通）和 ChinaMobile（中国移动）。	BGP
Ipv6CidrBlock	string	VPC 的 IPv6 网段。	2408:XXXX:0:6a::/56
SupportIpv4Gateway	boolean	是否支持 IPv4 网关。 true：是。 false：否。	true
Ipv4GatewayId	string	IPv4 网关的实例 ID。	ipv4gw-5tsnc6s4ogsedtp3k****
Tags	array<object>	标签列表信息。
Tag	object	标签列表信息。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua
AssociatedPropagationSources	array<object>	VPC 关联路由传播源。
AssociatedPropagationSources	object
SourceType	string	传播源类型。 CEN：云企业网。 VPN：VPN 网关。 TR：转发路由器。 ECR：专线网关。	CEN
SourceOwnerId	long	传播源所属账号的 ID。	153980532164****
SourceInstanceId	string	传播源实例 ID。	cen-dc4vwznpwbobrl****
Status	string	绑定状态。 Attaching：绑定中。 Attached：已绑定。 Detaching：解绑中。	Attaching
RoutePropagated	boolean	是否给本 VPC 传播路由。	true
EnabledIpv6	boolean	是否开启 IPv6。枚举值： false：false。 true：true。	false

示例

正常返回示例

JSON格式

{
  "CreationTime": "2021-10-16T07:31:09Z",
  "Status": "Available",
  "VpcId": "vpc-bp18sth14qii3pnvo****",
  "IsDefault": false,
  "ClassicLinkEnabled": false,
  "OwnerId": 0,
  "RegionId": "cn-hangzhou",
  "VpcName": "doctest2",
  "VRouterId": "vrt-bp1jso6ng1at0ajsc****",
  "DhcpOptionsSetStatus": "Available",
  "CidrBlock": "192.168.0.0/16",
  "RequestId": "7486AE4A-129D-43DB-A714-2432C074BA04",
  "Description": "VPC",
  "ResourceGroupId": "rg-acfmxazbvgb4ph****",
  "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
  "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
  "VSwitchIds": {
    "VSwitchId": [
      "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}"
    ]
  },
  "UserCidrs": {
    "UserCidr": [
      "172.16.0.1/24"
    ]
  },
  "SecondaryCidrBlocks": {
    "SecondaryCidrBlock": [
      "192.168.0.0/16"
    ]
  },
  "AssociatedCens": {
    "AssociatedCen": [
      {
        "CenOwnerId": 0,
        "CenId": "cen-7qthudw0ll6jmc****",
        "CenStatus": "Attached"
      }
    ]
  },
  "CloudResources": {
    "CloudResourceSetType": [
      {
        "ResourceCount": 1,
        "ResourceType": "VSwitch"
      }
    ]
  },
  "Ipv6CidrBlocks": {
    "Ipv6CidrBlock": [
      {
        "Ipv6Isp": "BGP",
        "Ipv6CidrBlock": "2408:XXXX:0:6a::/56"
      }
    ]
  },
  "SupportIpv4Gateway": true,
  "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "AssociatedPropagationSources": {
    "AssociatedPropagationSources": [
      {
        "SourceType": "CEN",
        "SourceOwnerId": 0,
        "SourceInstanceId": "cen-dc4vwznpwbobrl****",
        "Status": "Attaching",
        "RoutePropagated": true
      }
    ]
  },
  "EnabledIpv6": false,
  "DnsHostnameStatus": ""
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectVpcStatus	Current VPC status does not support this operation.	当前VPC的状态无法支持这个操作。
400	Forbidden.VpcNotFound	Specified VPC does not exist.	-
404	InvalidVpcId.NotFound	Specified VPC does not exist.	该VPC不存在。
500	InternalError	The request processing has failed due to some unknown error.	请求处理由于某些未知错误失败。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-24	OpenAPI 错误码发生变更	查看变更详情
2024-04-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-05	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情