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	否	過濾值列表。	1
	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	object
PhysicalConnectionType	array<object>	物理專線資訊列表。
	array<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	integer	物理專線的頻寬。單位：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	integer	共用專線關聯的物理專線所屬的阿里雲帳號（主帳號）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	object
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****
OpticalModuleModel	string
MacsecKeys	object
MacsecKey	array<object>
	object
CipherSuite	string
Ckn	string
Cak	string
StartOn	string
Status	string

樣本

正常返回樣本

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****",
        "OpticalModuleModel": "",
        "MacsecKeys": {
          "MacsecKey": [
            {
              "CipherSuite": "",
              "Ckn": "",
              "Cak": "",
              "StartOn": "",
              "Status": ""
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	OperationUnsupported.ResourceGroupId	ResourceGroupId in financial region is unsupported.
400	InvalidTagKey.Malformed	The specified tag key is invalid.
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。