文档

DescribePhysicalConnections - 查询指定地域内的物理专线

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

物理专线所在的地域 ID。

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

cn-hangzhou
PageNumberinteger

列表的页码,默认值:1

1
PageSizeinteger

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

10
IncludeReservationDataboolean

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

  • true:返回。

  • false(默认值):不返回。

false
ClientTokenstring

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

02fb3da4-130e-11e9-8e44-001
Filterobject []

过滤条件列表。

Keystring

过滤条件。取值:

  • 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:资源分配失败。
    • Terminating:终止中。
    • Terminated:已终止。
  • Name:物理专线的名称。

  • ProductType:专线类型。取值:

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

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

Name
Valuearray

过滤值列表。

string

过滤条件对应的过滤值。

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

nametest
Tagsobject []

标签列表。

Keystring

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

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

FinanceDept
Valuestring

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

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

FinanceJoshua
ResourceGroupIdstring

物理专线所在的资源组 ID。

rg-aek2yvwibxr****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

0E6D0EC4-7C91-53E2-9F65-64BF713114B0
PageNumberinteger

列表的页码,默认值:1

1
PageSizeinteger

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

10
TotalCountinteger

列表条目数。

1
PhysicalConnectionSetobject []

物理专线信息列表。

Typestring

物理专线的类型。取值:VPC

VPC
Statusstring

物理专线的状态。取值:

  • Initial:申请中。

  • Approved:审批通过。

  • Allocating:正在分配资源。

  • Allocated:接入施工中。

  • Confirmed:等待用户确认。

  • Enabled:已开通。

  • Rejected:申请被拒绝。

  • Canceled:已取消。

  • Allocation Failed:资源分配失败。

  • Terminating:终止中。

  • Terminated:已终止。

Enabled
CreationTimestring

物理专线的创建时间。

2021-08-24T07:30:58Z
AdLocationstring

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

浙江省杭州市XX区XX镇XX路10号
ReservationActiveTimestring

未生效订单的生效时间。

2022-02-25T11:01:04Z
ReservationOrderTypestring

未生效订单的订单类型。

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

RENEW
PortNumberstring

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

1/1/1
Specstring

物理专线的规格。

单位:G 表示 Gbps。

10G
ChargeTypestring

物理专线的付费方式。

取值:Prepaid,表示预付费。

Prepaid
ReservationInternetChargeTypestring

未生效订单的付费类型。

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

PayByBandwidth
Descriptionstring

物理专线的描述信息。

desctest
Bandwidthlong

物理专线的带宽。

单位:Mbps。

10
EnabledTimestring

物理专线的开通时间。

2021-08-24T07:33:18Z
LineOperatorstring

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

  • CT:中国电信。

  • CU:中国联通。

  • CM:中国移动。

  • CO:中国其他。

  • Equinix:Equinix。

  • Other:境外其他。

CT
PeerLocationstring

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

浙江省杭州市XX区XX镇XX路XX号
RedundantPhysicalConnectionIdstring

冗余物理专线的 ID。

pc-119mfjzm****
Namestring

物理专线的名称。

nametest
CircuitCodestring

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

longtel001
EndTimestring

物理专线的到期时间。

2022-04-24T16:00:00Z
PortTypestring

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

  • 100Base-T:百兆电口。

  • 1000Base-T:千兆电口。

  • 1000Base-LX:千兆单模光口(10 千米)。

  • 10GBase-T:万兆电口。

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

  • 40GBase-LR:四万兆单模光口。

  • 100GBase-LR:十万兆单模光口。

说明 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
AccessPointTypestring

物理专线接入点类型。

VPC
HasReservationDatastring

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

  • true:包含。

  • false:未包含。

false
PhysicalConnectionIdstring

物理专线的实例 ID。

pc-bp1ciz7ekd2grn1as****
ProductTypestring

物理专线类型。取值:

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

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

0
ParentPhysicalConnectionIdstring

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

pc-bp1ciz7ekd2grn1as****
ParentPhysicalConnectionAliUidlong

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

132193271328****
VlanIdstring

共享专线的 VLAN ID。

10
OrderModestring

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

  • PayByPhysicalConnectionOwner:表示合作伙伴付费。
  • PayByVirtualPhysicalConnectionOwner:表示租户付费。
PayByPhysicalConnectionOwner
VpconnStatusstring

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

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

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

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

50M
ResourceGroupIdstring

资源组 ID。

rg-acfmwu3k52p****
AdDetailLocationstring

表示机房及机柜的信息。

浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜, position30
Tagsobject []

标签列表。

Keystring

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

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

FinanceDept
Valuestring

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

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

FinanceJoshua
QosIdstring

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错误码错误信息描述
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.key该过滤器的Key不支持:Filter.X.key。

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

变更历史

变更时间变更内容概要操作
2024-02-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-08-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 404 变更
出参OpenAPI 返回结构发生变更
2023-04-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-11-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-09-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-09-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈