文档

GetVcc - 查询灵骏连接详情

更新时间:

查询某个灵骏连接的详细信息,包括规格,物理专线接入端口类型,实例状态,带宽,BGP网段等。

调试

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

授权信息

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

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

请求参数

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

地域 ID

cn-wulanchabu
VccIdstring

灵骏连接实例 ID

vcc-cn-zvp2w222***
PageNumberinteger

分页参数:当前参数已废弃

1
PageSizeinteger

分页参数:当前参数已废弃

20
EnablePageboolean

分页参数:当前参数已废弃

false
ClientTokenstring

popApi 默认不忽略,幂等使用

c5e3130a-d02f-11ec-a7d3-0242ac110005

返回参数

名称类型描述示例值
object

AjaxResult

Codeinteger

响应状态码

0
Messagestring

错误信息。(当实例状态为异常时,提示异常原因)

成功
RequestIdstring

当次请求的 Request ID

CAD09E47-B651-5206-B2DC-3AB78C8EB446
Contentobject

响应内容

TenantIdstring

租户 ID

1620939556166279
RegionIdstring

地域 ID

cn-wulanchabu
ZoneIdstring

可用区 ID

cn-wulanchabu-b
VccIdstring

灵骏连接实例 ID

vcc-cn-cqf2xh40101
VpdIdstring

灵骏网段实例 ID

vpd-d3isyds4
VpcIdstring

专有网络 ID;什么是专有网络

可调用 DescribeVpcs 接口查询指定 VPC。

vpc-j6ctp4n75306phv5tmpsm
VSwitchIdstring

交换机实例 ID。专有网络交换机

你可以调用 DescribeVSwitches 接口查询已创建的交换机。

vsw-uf6u8473r84e6n1n19he5
CenIdstring

云企业网实例的 ID;什么是云企业网?

你可用调用 DescribeCens 查询当前阿里云账号下的云企业网实例信息。

cen-m2iskbojlvda5w65fp
VccNamestring

灵骏连接实例名称

vcc-heyuan-backup
AccessPointIdstring

物理专线接入点的 ID:

  • ap-cn-wulanchabu-jn-ts-A:乌兰察布-集宁-A
  • ap-cn-heyuan-yc-ts-SA127:河源-源城-A
ap-cn-wulanchabu-jn-ts-A
LineOperatorstring

提供接入物理线路的运营商。取值:

  • CO:中国其他
CO
Specstring

规格;取值:

  • Large :大型
Large
PortTypestring

物理专线接入端口类型。取值:

  • 100GBase-LR:十万兆单模光口(10 千米)
100GBase-LR
PricingCyclestring

计费周期。取值:

  • Month:按月计费
  • Year:按年计费
Month
PayTypestring

实例的付费类型,返回:

  • PREPAY:包年包月
  • POSTPAY:按量付费
PrePay
Durationstring

续费周期

1
Statusstring

实例状态。可能值:

  • Available:正常 。

  • Not Available:不可用。

  • Executing:执行中。

  • Deleting:删除中。

Available
CurrentNodestring

当前节点

创建物理专线1
InternetChargeTypestring

网络计费类型。

  • PayByTraffic:按流量计费

  • PayByBandwidth:按带宽计费

PayByBandwidth
BandwidthStrstring

带宽

1G
Messagestring

错误信息。(当实例状态为异常时,提示异常原因)

成功
CreateTimestring

创建时间

1648085472000
GmtModifiedstring

修改时间

1648085472000
CommodityCodestring

商品代码

bccluster_cloudconnectionpre_public_cn
BgpCidrstring

BGP 网段

10.4.0.0/24
ExpirationDatestring

过期时间

1678379917000
VpdBaseInfoobject

灵骏网段信息;(适用于老版本的灵骏连接直接绑定灵骏网段的场景)

VpdIdstring

灵骏网段实例 ID

vpd-ppdunxzc
VpdNamestring

灵骏网段实例名称

yzp-rg-test3
Cidrstring

网络地址段

172.18.0.0/24
CreateTimestring

创建时间

1678379917000
AttachErStatusboolean

灵骏 HUB 是否已绑定网络实例

  • true : 已绑定
  • false : 未绑定
true
ErInfosarray<object>

已绑定的灵骏 HUB 信息列表

object

已绑定的灵骏 HUB 信息

CreateTimestring

创建时间

1678379917000
GmtModifiedstring

修改时间

1678379917000
Messagestring

提示信息

成功
ErIdstring

灵骏 HUB ID

er-p68b0jwn
RegionIdstring

灵骏 HUB 地域信息

cn-wulanchabu
TenantIdstring

租户 ID

1620939556166277
Statusstring

状态

Available
ErNamestring

灵骏 HUB 实例名称

er-1
MasterZoneIdstring

主可用区

cn-wulanchabu-b
Descriptionstring

描述

描述
Connectionslong

连接数

2
RouteMapslong

路由策略数量

2
AliyunRouterInfoarray<object>

阿里云路由信息列表

object

阿里云路由信息

PcIdstring

物理专线 ID

pc-0jlof4bphlsnxbdztkvad
VbrIdstring

边界路由器实例 ID

vbr-2ze4i85p6vb9nwcan5xt0
LocalGatewayIpstring

阿里云侧互联 IPv4 地址

169.254.248.30
PeerGatewayIpstring

灵骏侧互联 IPv4 地址

169.254.248.28
Maskstring

掩码

255.255.255.248
VlanIdstring

边界路由器实例的 VLAN ID

1042
CisRouterInfoarray<object>

灵骏网络路由信息列表

object

灵骏网络路由信息

CcrIdstring

云上路由器实例 ID

ccr-1ms84am0
CcInfosarray<object>

专线信息列表

object

专线信息

CcIdstring

专线 ID

cc-73aeex5o
VlanIdstring

专线的 Vlan ID

Ethernet1042
LocalGatewayIpstring

灵骏侧互联 IPv4 地址

169.254.248.26
RemoteGatewayIpstring

灵骏侧互联 IPv4 地址

169.254.248.30
SubnetMaskstring

子网掩码

255.255.255.248
Statusstring

实例状态

Established
ResourceGroupIdstring

资源组 ID。

关于资源组的更多信息,请参见什么是资源组

rg-aek2l4sq6l7unhi
Tagsarray<object>

标签信息。

一次最多支持输入 20 个标签信息。

object

标签信息

TagKeystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 aliyun 或者 acs:开头,不能包含 http://或者 https://。

一次最多支持输入 20 个标签的标签键。

tag-vcc
TagValuestring

资源的标签值。

标签值可以为空或输入不超过 128 个字符的字符串,不能以 aliyun 或者 acs:开头,不能包含 http://或者 https://。

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

vcc-group-1
ConnectionTypestring

连接方式,可选值:

  • VPC
  • CENTR
CENTR
CenOwnerIdstring

云企业网所属账号

1620939556166279
VbrInfosarray<object>

边界路由器信息列表

object

边界路由器信息

VbrIdstring

边界路由器 ID

vbr-wz96agu9h3d50z****
CenIdstring

云企业网 ID

cen-cx0qua8q6cm4z9****
Statusstring

边界路由器状态。取值:

  • unconfirmed:等待他人确认。

  • active:正常。

  • terminating:终止接入中。

  • terminated:已终止接入。

  • recovering:恢复中。

  • deleting:删除中。

  • Available: 可用。

Available
GmtCreatestring

创建时间

1683250981000
GmtModifiedstring

修改时间

1673578603000
VbrBgpPeersarray<object>

BGP 邻居信息列表

object

BGP 邻居信息

BgpGroupIdstring

BGP 组 ID

bgpg-2ze2sit2vakrkapvy****
BgpPeerIdstring

BGP 邻居 ID

bgp-uf6heugif9enu48rj****
PeerIpAddressstring

BGP 邻居 IP

169.254.****
PeerAsnstring

Peer AS 号

98765****
Statusstring

BGP 邻居的状态。取值:

  • Pending:待定。

  • Available:可用。

  • Modifying:修改中。

  • Deleting:删除中。

  • Deleted:已删除。

  • Not Available:不可用。

Available
BgpAsnstring

BGP AS 号

45644

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "CAD09E47-B651-5206-B2DC-3AB78C8EB446",
  "Content": {
    "TenantId": "1620939556166279",
    "RegionId": "cn-wulanchabu",
    "ZoneId": "cn-wulanchabu-b",
    "VccId": "vcc-cn-cqf2xh40101",
    "VpdId": "vpd-d3isyds4",
    "VpcId": "vpc-j6ctp4n75306phv5tmpsm",
    "VSwitchId": "vsw-uf6u8473r84e6n1n19he5",
    "CenId": "cen-m2iskbojlvda5w65fp",
    "VccName": "vcc-heyuan-backup",
    "AccessPointId": "ap-cn-wulanchabu-jn-ts-A",
    "LineOperator": "CO",
    "Spec": "Large",
    "PortType": "100GBase-LR",
    "PricingCycle": "Month",
    "PayType": "PrePay",
    "Duration": "1",
    "Status": "Available",
    "CurrentNode": "创建物理专线1",
    "InternetChargeType": "PayByBandwidth",
    "BandwidthStr": "1G",
    "Message": "成功",
    "CreateTime": "1648085472000",
    "GmtModified": "1648085472000",
    "CommodityCode": "bccluster_cloudconnectionpre_public_cn",
    "BgpCidr": "10.4.0.0/24",
    "ExpirationDate": "1678379917000",
    "VpdBaseInfo": {
      "VpdId": "vpd-ppdunxzc",
      "VpdName": "yzp-rg-test3",
      "Cidr": "172.18.0.0/24",
      "CreateTime": "1678379917000"
    },
    "AttachErStatus": true,
    "ErInfos": [
      {
        "CreateTime": "1678379917000",
        "GmtModified": "1678379917000",
        "Message": "成功",
        "ErId": "er-p68b0jwn",
        "RegionId": "cn-wulanchabu",
        "TenantId": "1620939556166277",
        "Status": "Available",
        "ErName": "er-1",
        "MasterZoneId": "cn-wulanchabu-b",
        "Description": "描述",
        "Connections": 2,
        "RouteMaps": 2
      }
    ],
    "AliyunRouterInfo": [
      {
        "PcId": "pc-0jlof4bphlsnxbdztkvad",
        "VbrId": "vbr-2ze4i85p6vb9nwcan5xt0",
        "LocalGatewayIp": "169.254.248.30",
        "PeerGatewayIp": "169.254.248.28",
        "Mask": "255.255.255.248",
        "VlanId": "1042"
      }
    ],
    "CisRouterInfo": [
      {
        "CcrId": "ccr-1ms84am0",
        "CcInfos": [
          {
            "CcId": "cc-73aeex5o",
            "VlanId": "Ethernet1042",
            "LocalGatewayIp": "169.254.248.26",
            "RemoteGatewayIp": "169.254.248.30\n",
            "SubnetMask": "255.255.255.248",
            "Status": "Established"
          }
        ]
      }
    ],
    "ResourceGroupId": "rg-aek2l4sq6l7unhi",
    "Tags": [
      {
        "TagKey": "tag-vcc",
        "TagValue": "vcc-group-1"
      }
    ],
    "ConnectionType": "CENTR",
    "CenOwnerId": "1620939556166279",
    "VbrInfos": [
      {
        "VbrId": "vbr-wz96agu9h3d50z****",
        "CenId": "cen-cx0qua8q6cm4z9****",
        "Status": "Available",
        "GmtCreate": "1683250981000",
        "GmtModified": "1673578603000",
        "VbrBgpPeers": [
          {
            "BgpGroupId": "bgpg-2ze2sit2vakrkapvy****",
            "BgpPeerId": "bgp-uf6heugif9enu48rj****",
            "PeerIpAddress": "169.254.****",
            "PeerAsn": "98765****",
            "Status": "Available"
          }
        ]
      }
    ],
    "BgpAsn": "45644"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-31OpenAPI 返回结构发生变更查看变更详情
2023-12-08API 内部配置变更,不影响调用查看变更详情
2023-11-16OpenAPI 返回结构发生变更查看变更详情