文档

DescribeVpcAttribute - 查询指定VPC的配置信息

更新时间:

查询指定VPC的配置信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeVpcAttributeRead
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
  • vpc:tag

请求参数

名称类型必填描述示例值
VpcIdstring

要查询的 VPC 的 ID。

vpc-bp18sth14qii3pnv****
RegionIdstring

VPC 所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 2xx HTTP 状态码并直接查询资源状况。

false
IsDefaultboolean

是否为默认 VPC,取值:

  • false(默认值):不是默认 VPC。

  • true:是默认 VPC。

false

返回参数

名称类型描述示例值
object

VPC 的创建时间。

CreationTimestring

VPC 的创建时间。

2021-10-16T07:31:09Z
Statusstring

VPC 的状态。取值:

  • Available:可用。

  • Pending:配置中。

Available
VpcIdstring

VPC 的 ID。

vpc-bp18sth14qii3pnvo****
IsDefaultboolean

是否是默认 VPC。取值:

  • true:是默认 VPC。

  • false(默认值):非默认 VPC。

false
ClassicLinkEnabledboolean

是否开启了 ClassicLink 功能。取值:

  • true:已开启。

  • false(默认值):未开启。

false
OwnerIdlong

VPC 所属的账号 ID。

283117732402483989
RegionIdstring

VPC 所在的地域 ID。

cn-hangzhou
VpcNamestring

VPC 的名称。

doctest2
VRouterIdstring

VPC 的路由器 ID。

vrt-bp1jso6ng1at0ajsc****
DhcpOptionsSetStatusstring

DHCP 选项集的状态。取值:

  • Available:可用。

  • InUse:使用中。

  • Deleted:已删除。

  • Pending:配置中。

Available
CidrBlockstring

VPC 的 IPv4 网段。

192.168.0.0/16
RequestIdstring

请求 ID。

7486AE4A-129D-43DB-A714-2432C074BA04
Descriptionstring

VPC 的描述。

VPC
ResourceGroupIdstring

资源组 ID。

rg-acfmxazbvgb4ph****
DhcpOptionsSetIdstring

DHCP 选项集的 ID。

dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlockstring

VPC 的 IPv6 网段。

2408:XXXX:0:a600::/56
VSwitchIdsarray

VPC 下的交换机列表。

string

VPC 下的交换机列表。

{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
UserCidrsarray

用户侧网络的网段,如定义了多个网段,返回时会以半角逗号(,)隔开,最多支持 3 个网段。

string

用户侧网络的网段,如定义了多个网段,返回时会以半角逗号(,)隔开,最多支持 3 个网段。

172.16.0.1/24
SecondaryCidrBlocksarray

VPC 附加 IPv4 网段。

string

VPC 附加 IPv4 网段。

192.168.0.0/16
AssociatedCensobject []

绑定的云企业网列表。

如果 VPC 未绑定云企业网,则不返回该参数。

CenOwnerIdlong

云企业网所属账号的 ID。

283117732402483989
CenIdstring

VPC 绑定的云企业网实例 ID。

cen-7qthudw0ll6jmc****
CenStatusstring

VPC 绑定云企业网的状态。

仅 VPC 绑定了云企业网时返回 Attached

Attached
CloudResourcesobject []

VPC 下的资源列表。

ResourceCountinteger

VPC 下的资源数量。

1
ResourceTypestring

VPC 下的资源类型。取值:

  • VSwitch:交换机。

  • VRouter:路由器。

  • RouteTable:路由表。

VSwitch
Ipv6CidrBlocksobject []

VPC 的 IPv6 网段信息。

Ipv6Ispstring

VPC 的 IPv6 地址段类型。取值:

  • BGP(默认值):阿里云 BGP IPv6。
  • ChinaMobile:中国移动(单线)。
  • ChinaUnicom:中国联通(单线)。
  • ChinaTelecom:中国电信(单线)。
说明 如果是开通了单线带宽白名单的用户,该字段可以设置为 ChinaTelecom(中国电信)、ChinaUnicom(中国联通)和 ChinaMobile(中国移动)。
BGP
Ipv6CidrBlockstring

VPC 的 IPv6 网段。

2408:XXXX:0:6a::/56
SupportIpv4Gatewayboolean

是否支持 IPv4 网关。

  • true:是。
  • false:否。
true
Ipv4GatewayIdstring

IPv4 网关的实例 ID。

ipv4gw-5tsnc6s4ogsedtp3k****
Tagsobject []

标签列表信息。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua
AssociatedPropagationSourcesobject []

VPC 关联路由传播源。

SourceTypestring

传播源类型。

  • CEN:云企业网。
  • VPN:VPN 网关。
  • TR:转发路由器。
  • ECR:专线网关。
CEN
SourceOwnerIdlong

传播源所属账号的 ID。

153980532164****
SourceInstanceIdstring

传播源实例 ID。

cen-dc4vwznpwbobrl****
Statusstring

绑定状态。

  • Attaching:绑定中。
  • Attached:已绑定。
  • Detaching:解绑中。
Attaching
RoutePropagatedboolean

是否给本 VPC 传播路由。

true
EnabledIpv6boolean

是否开启 IPv6。

枚举值:
  • falsefalse
  • truetrue
false

示例

正常返回示例

JSON格式

{
  "CreationTime": "2021-10-16T07:31:09Z",
  "Status": "Available",
  "VpcId": "vpc-bp18sth14qii3pnvo****",
  "IsDefault": false,
  "ClassicLinkEnabled": false,
  "OwnerId": 283117732402484000,
  "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": 283117732402484000,
        "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
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-04-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2024-01-05OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-05-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)