全部产品
Search
文档中心

专有网络 VPC:ListVirtualPhysicalConnections - 查询共享专线的信息

更新时间:Mar 04, 2024

调用ListVirtualPhysicalConnections接口查询共享专线的信息。

调试

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

授权信息

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

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

请求参数

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

共享专线关联的物理专线 ID。

本文以下内容将共享专线关联的物理专线,简称为物理专线,和共享专线互做区分。

pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionBusinessStatusstring

共享专线的商业状态。取值:

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:因安全原因被锁定。
Normal
VirtualPhysicalConnectionIdsarray

共享专线信息。

string

共享专线实例 ID。

支持输入多个实例 ID,N 的取值范围:1~20

pc-bp1mrgfbtmc9brre7****
IsConfirmedboolean

共享专线是否已被租户确认接收。取值:

  • true:是。
  • false:否。
true
VirtualPhysicalConnectionStatusesarray

共享专线的业务状态信息。

string

共享专线的业务状态。取值:

  • Confirmed:共享专线已被确认接收。
  • UnConfirmed:共享专线未被确认接收。
  • Deleted:共享专线已被删除。

支持输入多种业务状态,N 的取值范围:1~20

Confirmed
VirtualPhysicalConnectionAliUidsarray

共享专线拥有者的阿里云账号信息。

string

共享专线拥有者的阿里云账号(主账号)ID。

支持输入多个阿里云账号(主账号)ID,N 的取值范围:1~20

15346073170691****
VlanIdsarray

共享专线的 VLAN ID。

string

共享专线的 VLAN ID。

支持输入多个 VLAN ID,N 的取值范围:1~20

10
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
dd20****
RegionIdstring

共享专线所属的地域 ID。

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

cn-shanghai
Tagsobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

最多支持 128 个字符,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
ResourceGroupIdstring

共享专线所属的资源组 ID。

rg-acfmxazb4p****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

2A55F69E-EE3D-5CBE-8805-734F7D5B46B9
VirtualPhysicalConnectionsobject []

共享专线信息列表。

Typestring

物理专线的类型。默认值为 VPC

VPC
Statusstring

物理专线的状态。取值:

  • Initial:申请中。
  • Approved:审批通过。
  • Allocating:正在分配资源。
  • Allocated:接入施工中。
  • Confirmed:等待用户确认。
  • Enabled:已开通。
  • Rejected:申请被拒绝。
  • Canceled:已取消。
  • Allocation Failed:资源分配失败。
  • Terminated:已终止。
Enabled
CreationTimestring

物理专线的创建时间。

2021-06-08T12:20:55
AdLocationstring

物理专线接入设备所在的物理位置。

余杭经济开发区XXX交叉口, 余杭XX机房, E***包间
PortNumberstring

物理专线接入设备的端口号。

80
Specstring

共享专线的带宽值。

单位:M 表示 Mbps,G 表示 Gbps。

50M
ChargeTypestring

物理专线的付费方式。

取值:Prepaid,表示预付费。

Prepaid
Descriptionstring

物理专线的描述信息。

desctest
Bandwidthlong

物理专线的带宽。单位:Mbps。

50
EnabledTimestring

物理专线的开通时间。

2021-10-08T10:44Z
LineOperatorstring

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

  • CT:中国电信。
  • CU:中国联通。
  • CM:中国移动。
  • CO:中国其他。
  • Equinix:Equinix。
  • Other:境外其他。
CU
PeerLocationstring

本地数据中心的地理位置。

浙江省杭州市XX区XX街道XX号
RedundantPhysicalConnectionIdstring

冗余物理专线的 ID。

pc-119mfjzm****
Namestring

物理专线的名称。

nametest
CircuitCodestring

运营商为物理专线提供的电路编码。

longtel001
EndTimestring

共享专线的到期时间。

时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2021-11-08T16:00:00Z
PortTypestring

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

  • 100Base-T:百兆电口。
  • 1000Base-T:千兆电口。
  • 1000Base-LX:千兆单模光口(10 千米)。
  • 10GBase-T:万兆电口。
  • 10GBase-LR:万兆单模光口(10 千米)。
  • 40GBase-LR:四万兆单模光口。
  • 100GBase-LR:十万兆单模光口。
10GBase-LR
BusinessStatusstring

物理专线的商业状态。取值:

  • Normal:已开通。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:因安全原因被锁定。
Normal
LoaStatusstring

LOA 的状态。取值:

  • Applying:LOA 申请中。
  • Accept:LOA 申请通过。
  • Available:LOA 可用。
  • Rejected:LOA 申请驳回。
  • Completing:专线施工中。
  • Complete:专线施工完成。
  • Deleted:LOA 已删除。
Available
AccessPointIdstring

物理专线的接入点 ID。

ap-cn-hangzhou-finance-yh-E
PhysicalConnectionIdstring

共享专线实例 ID。

pc-bp1mrgfbtmc9brre7****
ProductTypestring

物理专线类型。取值:

  • VirtualPhysicalConnection:共享专线。
  • PhysicalConnection:独享专线。
VirtualPhysicalConnection
ParentPhysicalConnectionIdstring

物理专线的实例 ID。

pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionStatusstring

共享专线的业务状态。取值:

  • Confirmed:共享专线已确认接收。
  • UnConfirmed:共享专线未被确认接收。
  • Deleted:共享专线已被删除。
Confirmed
ParentPhysicalConnectionAliUidstring

物理专线所属的阿里云账号(主账号)ID。

18311773240248****
OrderModestring

共享专线的付费方式。取值:

  • PayByPhysicalConnectionOwner:表示共享专线关联的物理专线的拥有者付费。
  • PayByVirtualPhysicalConnectionOwner:表示共享专线的拥有者付费。
PayByPhysicalConnectionOwner
AliUidstring

共享专线拥有者的阿里云账号(主账号)ID。

15346073170691****
VlanIdstring

共享专线的 VLAN ID。

10
ExpectSpecstring

共享专线的预计带宽值。完成支付后,预计带宽值才能生效。

单位:M 表示 Mbps,G 表示 Gbps。

50M
ResourceGroupIdstring

共享专线所属的资源组 ID。

rg-acfm3wmsyui****
Tagsobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

最多支持 128 个字符,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
dd20****
TotalCountinteger

总条目数。

1
Countinteger

本次查询的条目数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
  "VirtualPhysicalConnections": [
    {
      "Type": "VPC",
      "Status": "Enabled",
      "CreationTime": "2021-06-08T12:20:55",
      "AdLocation": "余杭经济开发区XXX交叉口, 余杭XX机房, E***包间",
      "PortNumber": "80",
      "Spec": "50M",
      "ChargeType": "Prepaid",
      "Description": "desctest",
      "Bandwidth": 50,
      "EnabledTime": "2021-10-08T10:44Z",
      "LineOperator": "CU",
      "PeerLocation": "浙江省杭州市XX区XX街道XX号",
      "RedundantPhysicalConnectionId": "pc-119mfjzm****",
      "Name": "nametest",
      "CircuitCode": "longtel001",
      "EndTime": "2021-11-08T16:00:00Z",
      "PortType": "10GBase-LR",
      "BusinessStatus": "Normal",
      "LoaStatus": "Available",
      "AccessPointId": "ap-cn-hangzhou-finance-yh-E",
      "PhysicalConnectionId": "pc-bp1mrgfbtmc9brre7****",
      "ProductType": "VirtualPhysicalConnection",
      "ParentPhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
      "VirtualPhysicalConnectionStatus": "Confirmed",
      "ParentPhysicalConnectionAliUid": "18311773240248****",
      "OrderMode": "PayByPhysicalConnectionOwner",
      "AliUid": "15346073170691****",
      "VlanId": "10",
      "ExpectSpec": "50M",
      "ResourceGroupId": "rg-acfm3wmsyui****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "NextToken": "dd20****",
  "TotalCount": 1,
  "Count": 1
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.BandwidthThe param of Bandwidth [%s] is illegal.传入的带宽不合法。
400ResourceNotFound.PhysicalConnectionIdThe specified PhysicalConnectionId [%s] is not found.PhysicalConnectionId未找到。

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

变更历史

变更时间变更内容概要操作
2023-08-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2021-09-27新增 OpenAPI看变更集