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

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

物理专线所在的地域ID。

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

PageNumber Integer 1

列表的页码,默认值:1

PageSize Integer 10

分页查询时每页显示的条目数。默认值:10。 取值范围:1~50

IncludeReservationData Boolean false

是否返回未生效的订单数据。

  • true:返回。
  • false(默认值):不返回。
Action String DescribePhysicalConnections

要执行的操作。取值:DescribePhysicalConnections

ClientToken String 02fb3da4-130e-11e9-8e44-001****

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,需保证该参数在不同请求间唯一,最大值不超过64个ASCII字符。

Filter.N.Key String Name

过滤条件。取值:

  • PhysicalConnectionId:物理专线ID。
  • AccessPointId:接入点ID。
  • Type:物理专线类型。该过滤条件仅支持过滤值VPC
  • LineOperator:物理专线的运营商。该过滤条件支持以下过滤值:
    • CT:中国电信。
    • CU:中国联通。
    • CM:中国移动。
    • CO:中国其他。
    • Equinix:Equinix。
    • Other:境外其他。
  • Spec:物理专线的规格。该过滤条件支持以下过滤值:
    • 1G及以下
    • 10G
    • 40G
    • 100G
      说明 40G100G的规格默认不开放,已提交申请并通过的用户才可使用该过滤值。
  • Status:物理专线的状态。该过滤条件支持以下过滤值:
    • Initial:申请中。
    • Approved:审批通过。
    • Allocating:正在分配资源。
    • Allocated:接入施工中。
    • Confirmed:等待用户确认。
    • Enabled:已开通。
    • Rejected:申请被拒绝。
    • Canceled:已取消。
    • Allocation Failed:资源分配失败。
    • Terminated:已终止。
  • Name:物理专线的名称。

一次最多支持输入5个过滤条件。各个过滤条件之间为关系,符合所有的过滤条件,才会返回正确的查询结果。

Filter.N.Value.N String nametest

过滤条件对应的过滤值。

一个过滤条件支持最多输入5个过滤值,多个过滤值之间为关系,只要与其中一个过滤值匹配则视为符合该过滤条件。

返回数据

名称 类型 示例值 描述
RequestId String 0E6D0EC4-7C91-53E2-9F65-64BF713114B0

请求ID。

PageNumber Integer 1

列表的页码,默认值:1

PageSize Integer 10

分页查询时每页显示的条目数。默认值:10。 取值范围:1~50

TotalCount Integer 1

列表条目数。

PhysicalConnectionSet Array of PhysicalConnectionType

物理专线信息列表。

PhysicalConnectionType
Type String VPC

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

Status String Enabled

物理专线的状态。

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

物理专线的创建时间。

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

AdLocation String 余杭经济开发区XXX, 余杭XX机房, EXX包间XX

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

ReservationActiveTime String 2022-02-25T11:01:04Z

未生效订单的生效时间。

ReservationOrderType String RENEW

未生效订单的订单类型。

取值:RENEW,表示续费订单。

PortNumber String 1/1/1

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

Spec String 10G

物理专线的规格。

单位:G表示Gbps。

ChargeType String Prepaid

物理专线的付费方式。

取值:Prepaid,表示预付费。

ReservationInternetChargeType String PayByBandwidth

未生效订单的付费类型。

取值:PayByBandwidth,表示按使用带宽付费。

Description String desctest

物理专线的描述信息。

Bandwidth Long 10

物理专线的带宽。

单位:Gbps。

EnabledTime String 2021-08-24T07:33:18Z

物理专线的开通时间。

LineOperator String CT

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

  • CT:中国电信。
  • CU:中国联通。
  • CM:中国移动。
  • CO:中国其他。
  • Equinix:Equinix。
  • Other:境外其他。
PeerLocation String 浙江省杭州市XX区XX街道XX号

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

RedundantPhysicalConnectionId String pc-119mfjzm****

冗余物理专线的ID。

Name String nametest

物理专线的名称。

CircuitCode String longtel001

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

EndTime String 2022-04-24T16:00:00Z

物理专线的到期时间。

PortType String 10GBase-LR

物理专线接入端口类型。

  • 100Base-T:百兆电口。
  • 1000Base-T:千兆电口。
  • 1000Base-LX:千兆单模光口(10千米)。
  • 10GBase-T:万兆电口。
  • 10GBase-LR:万兆单模光口(10千米)。
BusinessStatus String Normal

物理专线的商业状态。

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

LOA的状态。

  • Applying:LOA申请中。
  • Accept:LOA申请通过。
  • Available:LOA可用。
  • Rejected:LOA申请驳回。
  • Completing:专线施工中。
  • Complete:专线施工完成。
  • Deleted:LOA已删除。
AccessPointId String ap-cn-hangzhou-finance-yh-E

物理专线接入点的ID。

AccessPointType String VPC

物理专线接入点类型。

HasReservationData String false

是否包含未生效的订单数据。

  • true:包含。
  • false:未包含。
PhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

物理专线的实例ID。

ProductType String PhysicalConnection

物理专线类型。

  • VirtualPhysicalConnection:共享专线。
  • PhysicalConnection:独享专线。
VirtualPhysicalConnectionCount Integer 0

当前物理专线下已创建的共享专线数量。

ParentPhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

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

ParentPhysicalConnectionAliUid Long 283117732402483989

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

VlanId String 10

共享专线的VLAN ID。

OrderMode String PayByPhysicalConnectionOwner

共享专线的付费方式。

  • PayByPhysicalConnectionOwner:表示合作伙伴付费。
  • PayByVirtualPhysicalConnectionOwner:表示租户付费。
VpconnStatus String Confirmed

共享专线的业务状态。

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

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

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

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&IncludeReservationData=false
&Action=DescribePhysicalConnections
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePhysicalConnectionsResponse>
    <RequestId>0E6D0EC4-7C91-53E2-9F65-64BF713114B0</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <PhysicalConnectionSet>
        <Type>VPC</Type>
        <Status>Enabled</Status>
        <CreationTime>2021-08-24T07:30:58Z</CreationTime>
        <AdLocation>余杭经济开发区XXX, 余杭XX机房, EXX包间XX</AdLocation>
        <ReservationActiveTime>2022-02-25T11:01:04Z</ReservationActiveTime>
        <ReservationOrderType>RENEW</ReservationOrderType>
        <PortNumber>1/1/1</PortNumber>
        <Spec>10G</Spec>
        <ChargeType>Prepaid</ChargeType>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <Description>desctest</Description>
        <Bandwidth>10</Bandwidth>
        <EnabledTime>2021-08-24T07:33:18Z</EnabledTime>
        <LineOperator>CT</LineOperator>
        <PeerLocation>浙江省杭州市XX区XX街道XX号</PeerLocation>
        <RedundantPhysicalConnectionId>pc-119mfjzm****</RedundantPhysicalConnectionId>
        <Name>nametest</Name>
        <CircuitCode>longtel001</CircuitCode>
        <EndTime>2022-04-24T16:00:00Z</EndTime>
        <PortType>10GBase-LR</PortType>
        <BusinessStatus>Normal</BusinessStatus>
        <LoaStatus>Available</LoaStatus>
        <AccessPointId>ap-cn-hangzhou-finance-yh-E</AccessPointId>
        <AccessPointType>VPC</AccessPointType>
        <HasReservationData>false</HasReservationData>
        <PhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</PhysicalConnectionId>
        <ProductType>PhysicalConnection</ProductType>
        <VirtualPhysicalConnectionCount>0</VirtualPhysicalConnectionCount>
        <ParentPhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</ParentPhysicalConnectionId>
        <ParentPhysicalConnectionAliUid>283117732402484000</ParentPhysicalConnectionAliUid>
        <VlanId>10</VlanId>
        <OrderMode>PayByPhysicalConnectionOwner</OrderMode>
        <VpconnStatus>Confirmed</VpconnStatus>
        <ExpectSpec>50M</ExpectSpec>
    </PhysicalConnectionSet>
</DescribePhysicalConnectionsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "PhysicalConnectionSet" : [ {
    "Type" : "VPC",
    "Status" : "Enabled",
    "CreationTime" : "2021-08-24T07:30:58Z",
    "AdLocation" : "余杭经济开发区XXX, 余杭XX机房, EXX包间XX",
    "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号",
    "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" : 283117732402484000,
    "VlanId" : "10",
    "OrderMode" : "PayByPhysicalConnectionOwner",
    "VpconnStatus" : "Confirmed",
    "ExpectSpec" : "50M"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key 该过滤器的Key不支持:Filter.X.key。

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