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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePhysicalConnections

要执行的操作。

取值:DescribePhysicalConnections

RegionId String cn-hangzhou

物理专线所在的地域ID。

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

PageNumber Integer 10

列表的页码,默认值为1

PageSize Integer 1

分页查询时每页的行数,最大值为50,默认值为10

Filter.N.Key String 1

过滤条件。N的取值为1~5。支持以下过滤条件:

  • PhysicalConnectionId:物理专线ID。
  • AccessPointId:接入点ID。
  • Type:专线类型。
  • LineOperator:物理专线的运营商。
  • Spec:物理专线的规格。
  • Status:物理专线的状态。
  • Name:物理专线的名称。

一个过滤条件的多个值之间为或关系,只要与其中一个值吻合则视为符合该过滤条件。

各个过滤条件之间为与关系,符合所有的过滤条件,才会进入最终查询结果中。

Filter.N.Value.N RepeatList 1

对应过滤条件的取值。N的取值范围为1~5

IncludeReservationData Boolean false

是否返回未生效订单。

  • true:返回。
  • false(默认值):不返回。
ClientToken String 23243242rggy****

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

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

返回数据

名称 类型 示例值 描述
PhysicalConnectionSet Array of PhysicalConnectionType

物理专线的详细信息。

PhysicalConnectionType
AccessPointId String eip-2zeerraiwb7uj6i0*******

物理专线接入点的ID。

AdLocation String 广东省深圳市南山区滨海大道xxx基地xx座 Ax-x Bxx

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

Bandwidth Long 10

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

BusinessStatus String Normal

物理专线的付费状态。

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

收费类型。

取值:Prepaid,预付费。

CircuitCode String longtel001

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

CreationTime String 2017-06-08T12:20:55

物理专线的创建时间。

Description String 物理专线

物理专线的描述。

EnabledTime String 2017-06-08T12:20:55

物理专线的开通时间。

EndTime String 2019-02-25T11:01:04Z

到期时间。

HasReservationData String true

是否有订购消息。

  • true:有订购消息。
  • false:无订购消息。
LineOperator String CT

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

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

LOA的状态。

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

物理专线的名称。

PeerLocation String 浙江省杭州市XX区XX街道XX号

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

PhysicalConnectionId String pc-119mfjzm*****

物理专线的ID。

PortNumber String 80

专线接入设备的端口号。

PortType String 1000Base-T

物理专线接入端口类型。

  • 100Base-T:百兆电口。
  • 1000Base-T:千兆电口。
  • 1000Base-LX:千兆单模光口(10千米)。
  • 10GBase-T:万兆电口。
  • 10GBase-LR:万兆单模光口(10千米)。
RedundantPhysicalConnectionId String pc-119mfjzm*******

冗余物理专线的ID。

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

续费生效时间。

ReservationInternetChargeType String PayByBandwidth

续费类型。

ReservationOrderType String RENEW

续费订单类型。

Spec String Large

物理专线的规格。

Status String Enabled

物理专线的状态。

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

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

TotalCount Integer 10

列表条目数。

PageNumber Integer 10

列表的页码,默认值为1

PageSize Integer 10

分页查询时每页的行数,最大值为50,默认值为10

RequestId String EEC8EAB1-F299-4F5C-8E54-0A3129164C27

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribePhysicalConnections
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribePhysicalConnectionsResponse>
      <PhysicalConnectionSet>
            <PhysicalConnectionType>
                  <Status>Enabled</Status>
                  <Description>物理专线</Description>
                  <EndTime>2019-02-25T11:01:04Z</EndTime>
                  <LineOperator>CT</LineOperator>
                  <CircuitCode>longtel001</CircuitCode>
                  <PhysicalConnectionId>pc-119mfjzm*****</PhysicalConnectionId>
                  <HasReservationData>true</HasReservationData>
                  <RedundantPhysicalConnectionId>pc-119mfjzm*******</RedundantPhysicalConnectionId>
                  <PeerLocation>浙江省杭州市XX区XX街道XX号</PeerLocation>
                  <BusinessStatus>Normal</BusinessStatus>
                  <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
                  <Name>name</Name>
                  <ReservationOrderType>RENEW</ReservationOrderType>
                  <LoaStatus>Available</LoaStatus>
                  <Type>VPC</Type>
                  <AdLocation>广东省深圳市南山区滨海大道xxx基地xx座 Ax-x Bxx</AdLocation>
                  <ChargeType>Prepaid</ChargeType>
                  <Bandwidth>10</Bandwidth>
                  <CreationTime>2017-06-08T12:20:55</CreationTime>
                  <AccessPointId>eip-2zeerraiwb7uj6i0*******</AccessPointId>
                  <EnabledTime>2017-06-08T12:20:55</EnabledTime>
                  <ReservationActiveTime>2019-02-25T11:01:04Z</ReservationActiveTime>
                  <PortNumber>80</PortNumber>
                  <Spec>Large</Spec>
                  <PortType>1000Base-T</PortType>
            </PhysicalConnectionType>
      </PhysicalConnectionSet>
      <TotalCount>10</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>EEC8EAB1-F299-4F5C-8E54-0A3129164C27</RequestId>
      <PageNumber>10</PageNumber>
</DescribePhysicalConnectionsResponse>

JSON格式

{
    "PhysicalConnectionSet": {
        "PhysicalConnectionType": {
            "Status": "Enabled",
            "Description": "物理专线",
            "EndTime": "2019-02-25T11:01:04Z",
            "LineOperator": "CT",
            "CircuitCode": "longtel001",
            "PhysicalConnectionId": "pc-119mfjzm*****",
            "HasReservationData": true,
            "RedundantPhysicalConnectionId": "pc-119mfjzm*******",
            "PeerLocation": "浙江省杭州市XX区XX街道XX号",
            "BusinessStatus": "Normal",
            "ReservationInternetChargeType": "PayByBandwidth",
            "Name": "name",
            "ReservationOrderType": "RENEW",
            "LoaStatus": "Available",
            "Type": "VPC",
            "AdLocation": "广东省深圳市南山区滨海大道xxx基地xx座 Ax-x Bxx",
            "ChargeType": "Prepaid",
            "Bandwidth": 10,
            "CreationTime": "2017-06-08T12:20:55",
            "AccessPointId": "eip-2zeerraiwb7uj6i0*******",
            "EnabledTime": "2017-06-08T12:20:55",
            "ReservationActiveTime": "2019-02-25T11:01:04Z",
            "PortNumber": 80,
            "Spec": "Large",
            "PortType": "1000Base-T"
        }
    },
    "TotalCount": 10,
    "PageSize": 10,
    "RequestId": "EEC8EAB1-F299-4F5C-8E54-0A3129164C27",
    "PageNumber": 10
}

错误码

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

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