调用DescribePhysicalConnections查询指定地域内的物理专线_高速通道(Express Connect)-阿里云帮助中心

调用DescribePhysicalConnections接口查询指定地域内的物理专线信息。

接口说明

默认情况下，系统会查询指定地域内所有物理专线的信息，您可以通过 DescribePhysicalConnections 接口为您提供的过滤选项查询指定物理专线的信息。系统支持的过滤选项，请参见本文请求参数中 Key 的描述信息。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribePhysicalConnections	list	PhysicalConnection acs:vpc:{#regionId}:{#accountId}:physicalconnection/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	物理专线所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
PageNumber	integer	否	列表的页码，默认值：1。	1
PageSize	integer	否	分页查询时每页显示的条目数。默认值：10。取值范围：1~50。	10
IncludeReservationData	boolean	否	是否返回未生效的订单数据。取值： true：返回。 false（默认值）：不返回。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。	02fb3da4-130e-11e9-8e44-001
Filter	array<object>	否	过滤条件列表。
	object	否	过滤条件。
Key	string	否	过滤条件。取值： PhysicalConnectionId：物理专线 ID。 AccessPointId：接入点 ID。 Type：物理专线类型。该过滤条件仅支持过滤值 VPC。 LineOperator：物理专线的运营商。该过滤条件支持以下过滤值： CT：中国电信。 CU：中国联通。 CM：中国移动。 CO：中国其他。 Equinix：Equinix。 Other：境外其他。 Spec：物理专线的规格。该过滤条件支持以下过滤值： 1G 及以下。 10G。 40G。 100G。说明 40G、100G 的规格默认不开放，向客户经理已提交申请并通过的用户才可使用该过滤值。 Status：物理专线的状态。该过滤条件支持以下过滤值： Initial：申请中。 Approved：审批通过。 Allocating：正在分配资源。 Allocated：接入施工中。 Confirmed：等待用户确认。 Enabled：已开通。 Rejected：申请被拒绝。 Canceled：已取消。 Allocation Failed：资源分配失败。 Terminating：终止中。 Terminated：已终止。 Name：物理专线的名称。 ProductType：专线类型。取值： VirtualPhysicalConnection：共享专线。 PhysicalConnection：独享专线。一次最多支持输入 5 个过滤条件。各个过滤条件之间为与关系，符合所有的过滤条件，才会返回正确的查询结果。	Name
Value	array	否	过滤值列表。
	string	否	过滤条件对应的过滤值。一个过滤条件支持最多输入 5 个过滤值，多个过滤值之间为或关系，只要与其中一个过滤值匹配则视为符合该过滤条件。	nametest
Tags	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
ResourceGroupId	string	否	物理专线所在的资源组 ID。	rg-aek2yvwibxr****

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0E6D0EC4-7C91-53E2-9F65-64BF713114B0
PageNumber	integer	列表的页码，默认值：1。	1
PageSize	integer	分页查询时每页显示的条目数。默认值：10。取值范围：1~50。	10
TotalCount	integer	列表条目数。	1
PhysicalConnectionSet	array<object>	物理专线信息列表。
	object	物理专线的详细信息。
Type	string	物理专线的类型。取值：VPC。	VPC
Status	string	物理专线的状态。取值： Initial：申请中。 Approved：审批通过。 Allocating：正在分配资源。 Allocated：接入施工中。 Confirmed：等待用户确认。 Enabled：已开通。 Rejected：申请被拒绝。 Canceled：已取消。 Allocation Failed：资源分配失败。 Terminating：终止中。 Terminated：已终止。	Enabled
CreationTime	string	物理专线的创建时间。	2021-08-24T07:30:58Z
AdLocation	string	物理专线接入设备所在接入点位置。	浙江省杭州市XX区XX镇XX路10号
ReservationActiveTime	string	未生效订单的生效时间。	2022-02-25T11:01:04Z
ReservationOrderType	string	未生效订单的订单类型。取值：RENEW，表示续费订单。	RENEW
PortNumber	string	物理专线接入设备的端口号。	1/1/1
Spec	string	物理专线的规格。单位：G 表示 Gbps。	10G
ChargeType	string	物理专线的付费方式。取值：Prepaid，表示预付费。	Prepaid
ReservationInternetChargeType	string	未生效订单的付费类型。取值：PayByBandwidth，表示按使用带宽付费。	PayByBandwidth
Description	string	物理专线的描述信息。	desctest
Bandwidth	long	物理专线的带宽。单位：Mbps。	10
EnabledTime	string	物理专线的开通时间。	2021-08-24T07:33:18Z
LineOperator	string	提供接入物理线路的运营商。取值： CT：中国电信。 CU：中国联通。 CM：中国移动。 CO：中国其他。 Equinix：Equinix。 Other：境外其他。	CT
PeerLocation	string	本地数据中心的地理位置。	浙江省杭州市XX区XX镇XX路XX号
RedundantPhysicalConnectionId	string	冗余物理专线的 ID。	pc-119mfjzm****
Name	string	物理专线的名称。	nametest
CircuitCode	string	运营商为物理专线提供的电路编码。	longtel001
EndTime	string	物理专线的到期时间。	2022-04-24T16:00:00Z
PortType	string	物理专线接入端口类型。取值： 100Base-T：百兆电口。 1000Base-T：千兆电口。 1000Base-LX：千兆单模光口（10 千米）。 10GBase-T：万兆电口。 10GBase-LR：万兆单模光口（10 千米）。 40GBase-LR：四万兆单模光口。 100GBase-LR：十万兆单模光口。说明 40GBase-LR 和 100GBase-LR 需要根据实际后台端口水位情况进行创建，具体水位情况请联系商务经理。	10GBase-LR
BusinessStatus	string	物理专线的商业状态。取值： Normal：已开通。 FinancialLocked：欠费锁定。 SecurityLocked：因安全原因被锁定。	Normal
LoaStatus	string	LOA 的状态。取值： Applying：LOA 申请中。 Accept：LOA 申请通过。 Available：LOA 可用。 Rejected：LOA 申请驳回。 Completing：专线施工中。 Complete：专线施工完成。 Deleted：LOA 已删除。	Available
AccessPointId	string	物理专线接入点的 ID。	ap-cn-hangzhou-finance-yh-E
AccessPointType	string	物理专线接入点类型。	VPC
HasReservationData	string	是否包含未生效的订单数据。取值： true：包含。 false：未包含。	false
PhysicalConnectionId	string	物理专线的实例 ID。	pc-bp1ciz7ekd2grn1as****
ProductType	string	物理专线类型。取值： VirtualPhysicalConnection：共享专线。 PhysicalConnection：独享专线。	PhysicalConnection
VirtualPhysicalConnectionCount	integer	当前物理专线下已创建的共享专线数量。	0
ParentPhysicalConnectionId	string	共享专线关联的物理专线实例 ID。	pc-bp1ciz7ekd2grn1as****
ParentPhysicalConnectionAliUid	long	共享专线关联的物理专线所属的阿里云账号（主账号）ID。	132193271328****
VlanId	string	共享专线的 VLAN ID。	10
OrderMode	string	共享专线的付费方式。取值： PayByPhysicalConnectionOwner：表示合作伙伴付费。 PayByVirtualPhysicalConnectionOwner：表示租户付费。	PayByPhysicalConnectionOwner
VpconnStatus	string	共享专线的业务状态。取值： Confirmed：共享专线已确认接收。 UnConfirmed：共享专线未被确认接收。 Deleted：共享专线已被删除。	Confirmed
ExpectSpec	string	共享专线的预计带宽值。完成支付后，预计带宽值才能生效。单位：M 表示 Mbps，G 表示 Gbps。	50M
ResourceGroupId	string	资源组 ID。	rg-acfmwu3k52p****
AdDetailLocation	string	表示机房及机柜的信息。	浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜, position30
Tags	array<object>	标签列表。
	object	标签列表。
Key	string	资源的标签键。最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	资源的标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
QosId	string	QoS 策略实例 ID。	qos-bp10s3szn8rgnxuw7****

示例

正常返回示例

JSON格式

{
  "RequestId": "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "PhysicalConnectionSet": {
    "PhysicalConnectionType": [
      {
        "Type": "VPC",
        "Status": "Enabled",
        "CreationTime": "2021-08-24T07:30:58Z",
        "AdLocation": "浙江省杭州市XX区XX镇XX路10号",
        "ReservationActiveTime": "2022-02-25T11:01:04Z",
        "ReservationOrderType": "RENEW",
        "PortNumber": "1/1/1",
        "Spec": "10G",
        "ChargeType": "Prepaid",
        "ReservationInternetChargeType": "PayByBandwidth",
        "Description": "desctest",
        "Bandwidth": 10,
        "EnabledTime": "2021-08-24T07:33:18Z",
        "LineOperator": "CT",
        "PeerLocation": "浙江省杭州市XX区XX镇XX路XX号",
        "RedundantPhysicalConnectionId": "pc-119mfjzm****",
        "Name": "nametest",
        "CircuitCode": "longtel001",
        "EndTime": "2022-04-24T16:00:00Z",
        "PortType": "10GBase-LR",
        "BusinessStatus": "Normal",
        "LoaStatus": "Available",
        "AccessPointId": "ap-cn-hangzhou-finance-yh-E",
        "AccessPointType": "VPC",
        "HasReservationData": "false",
        "PhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
        "ProductType": "PhysicalConnection",
        "VirtualPhysicalConnectionCount": 0,
        "ParentPhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
        "ParentPhysicalConnectionAliUid": 0,
        "VlanId": "10",
        "OrderMode": "PayByPhysicalConnectionOwner",
        "VpconnStatus": "Confirmed",
        "ExpectSpec": "50M",
        "ResourceGroupId": "rg-acfmwu3k52p****",
        "AdDetailLocation": "浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜,  position30",
        "Tags": {
          "tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "QosId": "qos-bp10s3szn8rgnxuw7****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	OperationUnsupported.ResourceGroupId	ResourceGroupId in financial region is unsupported.	操作不支持，在金融云中不支持资源组id
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	该过滤器的Key不支持：Filter.X.key。

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

变更历史

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