文档

ListVccs - 查询灵骏连接

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

地域 ID

cn-wulanchabu
VpdIdstring

灵骏网段实例 ID

vpd-omqutbff
VpcIdstring

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

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

vpc-bp1nrtkmamy329u6a1z0i
CenIdstring

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

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

cen-95iwtpyvj3kk1v0ao0
Bandwidthinteger

灵骏连接实例的带宽峰值,单位 mbps。取值范围:1000~400000

5000
Statusstring

实例状态

Available
ExStatusstring

把指定状态的数据全部排除掉,如果 status 参数存在那么 ExStatus 就不会生效

Prepaid
VccIdstring

灵骏连接实例 ID

vcc-cn-zvp2w222001
FilterErIdstring

通过灵骏 HUB 实例 ID 过滤查询

er-a7rqv1rq
ResourceGroupIdstring

资源组 ID。

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

rg-aeky5f3qx6ceapq
Tagarray<object>

标签信息。

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

object

标签信息

Keystring

资源的标签键。

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

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

tag-vcc
Valuestring

资源的标签值。

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

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

vcc-group-1
PageNumberinteger

当前页码。起始值:1 默认值:1

1
PageSizeinteger

每页显示的行数。默认值:20

20
EnablePageboolean

是否开启分页查询,可选值:

  • true :开启分页查询
  • false :不开启分页查询
false

返回参数

名称类型描述示例值
object

AjaxResult<PageResult>

Codeinteger

响应状态码

0
Messagestring

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

成功
RequestIdstring

当次请求的 Request ID

28451248-7038-5184-B5D3-80F104654BE8
Contentobject

响应内容

Totallong

总记录数

0
Dataarray<object>

灵骏连接信息列表

object

灵骏连接信息

TenantIdstring

租户 ID

1620939556166279
RegionIdstring

地域 ID

cn-wulanchabu
ZoneIdstring

可用区 ID

cn-wulanchabu-b
VccIdstring

灵骏连接实例 ID

vcc-cn-zvp2w222001
VpdIdstring

灵骏网段实例 ID

vpd-eoiy88ju
VpcIdstring

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

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

vpc-f8ziirfl9k25h2qn7y4f8
CenIdstring

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

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

cen-w15qot0pfvs83pkckj
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
PortTypestring

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

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

实例状态

Init
CurrentNodestring

当前流程节点

持久化资源数据
Messagestring

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

成功
CreateTimestring

创建时间

1678273219000
GmtModifiedstring

更新时间

1678273219000
TaskIdstring

任务 Id

task-cd544092-ed0a-49e9-83eb-e8c94770dccf
VpdBaseInfoobject

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

VpdIdstring

灵骏网段实例 ID

vpd-9n7ioqrp
VpdNamestring

灵骏网段实例名称

yzp-rg-test3
Cidrstring

VPD 的网段。

  • 建议您使用 RFC 私网地址作为灵骏网段的网段如 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,多灵骏网段互通场景或灵骏网段和 VPC 互通场景需确保地址规划不能冲突。
  • 您也可以使用除 100.64.0.0/10、224.0.0.0/4、127.0.0.0/8 或 169.254.0.0/16 及其子网外的自定义地址段作为 VPD 的主 IPv4 网段。
10.0.0.0/13
CreateTimestring

创建时间

1668158213000
Ratedouble

流程进度;取值返回 0~1;未开始为 null

1
BandwidthStrstring

带宽

1000
CommodityCodestring

商品代码

bccluster_cloudconnectionpre_public_cn
BgpCidrstring

bgp 网段

172.16.128.0/24
ExpirationDatestring

过期时间

1678273219000
ResourceGroupIdstring

资源组 ID。

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

rg-aek2l4sq6l7unhi
ErInfosarray<object>

已绑定的灵骏 HUB 信息列表

object

已绑定的灵骏 HUB 信息

CreateTimestring

创建时间

1678273219000
GmtModifiedstring

修改时间

1678273219000
Messagestring

提示信息

成功
ErIdstring

弹性路由器 ID

er-a7rqv1rq
RegionIdstring

ER 地域信息

cn-wulanchabu
TenantIdstring

租户 ID

1620939556166277
Statusstring

状态

Available
ErNamestring

ER 实例名称

er-1
MasterZoneIdstring

主可用区

cn-wulanchabu-b
Descriptionstring

描述

描述
Connectionslong

连接数

2
RouteMapslong

路由策略数量

2
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

cen 所属账号

1238685214107736
BgpAsnstring

bgp as 号

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "28451248-7038-5184-B5D3-80F104654BE8",
  "Content": {
    "Total": 0,
    "Data": [
      {
        "TenantId": "1620939556166279\n",
        "RegionId": "cn-wulanchabu",
        "ZoneId": "cn-wulanchabu-b",
        "VccId": "vcc-cn-zvp2w222001",
        "VpdId": "vpd-eoiy88ju",
        "VpcId": "vpc-f8ziirfl9k25h2qn7y4f8",
        "CenId": "cen-w15qot0pfvs83pkckj",
        "VccName": "vcc-heyuan-backup",
        "AccessPointId": "ap-cn-wulanchabu-jn-ts-A",
        "LineOperator": "CO",
        "Spec": "Large",
        "PortType": "100GBase-LR\n",
        "Status": "Init",
        "CurrentNode": "持久化资源数据",
        "Message": "成功",
        "CreateTime": "1678273219000",
        "GmtModified": "1678273219000",
        "TaskId": "task-cd544092-ed0a-49e9-83eb-e8c94770dccf",
        "VpdBaseInfo": {
          "VpdId": "vpd-9n7ioqrp",
          "VpdName": "yzp-rg-test3",
          "Cidr": "10.0.0.0/13",
          "CreateTime": "1668158213000"
        },
        "Rate": 1,
        "BandwidthStr": "1000",
        "CommodityCode": "bccluster_cloudconnectionpre_public_cn",
        "BgpCidr": "172.16.128.0/24",
        "ExpirationDate": "1678273219000",
        "ResourceGroupId": "rg-aek2l4sq6l7unhi",
        "ErInfos": [
          {
            "CreateTime": "1678273219000",
            "GmtModified": "1678273219000",
            "Message": "成功",
            "ErId": "er-a7rqv1rq",
            "RegionId": "cn-wulanchabu",
            "TenantId": "1620939556166277",
            "Status": "Available",
            "ErName": "er-1",
            "MasterZoneId": "cn-wulanchabu-b",
            "Description": "描述",
            "Connections": 2,
            "RouteMaps": 2
          }
        ],
        "Tags": [
          {
            "TagKey": "tag-vcc",
            "TagValue": "vcc-group-1"
          }
        ],
        "ConnectionType": "CENTR",
        "CenOwnerId": "1238685214107736",
        "BgpAsn": ""
      }
    ]
  }
}

错误码

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