DescribeRouterInterfaces - 查詢指定地區內的路由器介面 - Express Connect

調用DescribeRouterInterfaces介面查詢指定地區內的路由器介面。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	路由器介面所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
IncludeReservationData	boolean	否	是否包含續約資料。取值： true：是。 false（預設值）：否。	false
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的行數，最大值為 50。預設值為 10。	10
Filter	array<object>	否	過濾資訊。
	object	否	過濾資訊。
Key	string	否	過濾條件，最多可提供 5 個過濾條件。支援以下過濾條件： RouterInterfaceId：路由器介面 ID。 RouterId：路由器 ID。 RouterType：路由器類型，取值為 VRouter 或 VBR。 RouterInterfaceOwnerId：路由器介面的所屬帳號 ID。 OppositeInterfaceId：對端路由器介面 ID。 OppositeRouterType：對端路由器介面類型，取值為 VRouter 或 VBR。 OppositeRouterId：對端路由器介面 ID。 OppositeInterfaceOwnerId：對端路由器介面所屬帳號 ID。 Status：路由器介面狀態。 Name：路由器介面名稱。說明每個過濾條件的多個值之間為或關係，即只要與其中一個值吻合則視為符合該過濾條件。各個過濾條件之間為與關係，即符合所有指定的過濾條件，才會進入最終的查詢結果。	Filter.1.Status
Value	array	否	根據 Key 指定過濾值。一個 Key 支援指定多個過濾值，每個過濾值之間是或的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。	Filter.1.Active 1
	string	否	根據 Key 指定過濾值。一個 Key 支援指定多個過濾值，每個過濾值之間是或的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。	test
ResourceGroupId	string	否	資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。	rg-acfmxazb4ph6aiy****
Tags	array<object>	否	資源的標籤。
	object	否	標籤。
Key	string	否	資源的標籤鍵。至少輸入 1 個標籤鍵，最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	請求 ID。	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	列表的頁碼，預設值為 1。	1
PageSize	integer	分頁查詢時每頁的行數，最大值為 50。預設值為 10。	10
TotalCount	integer	列表條目數。	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	路由器介面的詳細資料。
	array<object>	路由器介面的詳細資料。
ReservationActiveTime	string	續約生效時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mmZ`。	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	健全狀態檢查目標 IP。	116.62.XX.XX
Status	string	路由器介面的狀態。	active
CreationTime	string	路由表的建立時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mmZ`。	2021-06-08T12:20:55
ReservationOrderType	string	續約訂單類型。	RENEWCHANGE
OppositeInterfaceId	string	對端路由器介面 ID。	ri-bp1itx13bwe6f2wfh****
Spec	string	路由器介面的規格。	Large
ChargeType	string	付費方式。	PayByTraffic
RouterInterfaceId	string	路由器介面 ID。	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	健全狀態檢查閾值。	2
OppositeRouterType	string	串連對端的路由器介面所屬的路由器類型。	VRouter
VpcInstanceId	string	對等串連中本端 VPC 的 ID。	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	對端路由器介面所屬的帳號 ID。	271598332402530847
OppositeVpcInstanceId	string	對端 VPC 的 ID。	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	續約付費類型。	PayByBandwidth
CrossBorder	boolean	是否是跨境串連。	false
Bandwidth	integer	路由器介面的頻寬。單位：Mbps。	10
Description	string	路由表介面描述。	路由表介面描述
HcRate	integer	健全狀態檢查速率。	1
ReservationBandwidth	string	續約頻寬。單位：Mbps。	10
Name	string	自訂名稱。	test
OppositeRouterId	string	串連對端的路由器介面所屬的路由器 ID。	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	串連對端路由器介面的規格。	Large
RouterId	string	路由條目所在路由器的 ID。	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	串連對端的路由器介面的業務狀態。	Normal
ConnectedTime	string	串連建立的時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mmZ`。	2021-06-08T12:20:55
HealthCheckSourceIp	string	健全狀態檢查源 IP。	116.62.XX.XX
OppositeInterfaceStatus	string	串連對端的路由器介面的狀態。	Normal
EndTime	string	擷取資料的結束時間點。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：`YYYY-MM-DDThh:mmZ`。	2021-06-08T12:20:55
OppositeRegionId	string	串連對端所在的地區 ID。	cn-shanghai
OppositeAccessPointId	string	對端存取點 ID。	ap-cn-shanghaiSZ-****
BusinessStatus	string	路由器介面的業務狀態。取值： Normal：正常。 FinancialLocked：欠費鎖定。 SecurityLocked：安全風控鎖定。	Normal
OppositeBandwidth	integer	對端頻寬。單位：Mbps。	12
RouterType	string	路由表所在路由器的類型。取值： VRouter：VPC 路由器。 VBR：邊界路由器。	VRouter
Role	string	對等串連中的角色。	InitiatingSide
HasReservationData	string	是否有續約資料。	false
AccessPointId	string	存取點 ID。	ap-cn-shanghaiSZ-****
Ipv6Status	string	是否開啟 IPv6 安全防護。取值： on：開啟。 off：關閉。 unsupport：不支援。	on
FastLinkMode	boolean	是否為使用快速串連模式建立的 VBR 上聯路由器介面，快速串連模式可實現 VBR 和 VPC 兩端路由器介面建立完畢後自動完成串連。取值： true：是。 false（預設值）：否。	false
ResourceGroupId	string	資源群組 ID。關於資源群組的更多資訊，請參見什麼是資源群組。	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	資源的標籤。
	object	標籤。
Key	string	資源的標籤鍵。	FinanceDept
Value	string	資源的標籤值。	FinanceJoshua

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ReservationActiveTime": "2021-03-11T16:00:00Z",
        "HealthCheckTargetIp": "116.62.XX.XX",
        "Status": "active",
        "CreationTime": "2021-06-08T12:20:55",
        "ReservationOrderType": "RENEWCHANGE",
        "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
        "Spec": "Large",
        "ChargeType": "PayByTraffic",
        "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
        "HcThreshold": 2,
        "OppositeRouterType": "VRouter",
        "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
        "OppositeInterfaceOwnerId": "271598332402530847",
        "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "CrossBorder": false,
        "Bandwidth": 10,
        "Description": "路由表介面描述",
        "HcRate": 1,
        "ReservationBandwidth": "10",
        "Name": "test",
        "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceSpec": "Large",
        "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceBusinessStatus": "Normal",
        "ConnectedTime": "2021-06-08T12:20:55",
        "HealthCheckSourceIp": "116.62.XX.XX",
        "OppositeInterfaceStatus": "Normal",
        "EndTime": "2021-06-08T12:20:55",
        "OppositeRegionId": "cn-shanghai",
        "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
        "BusinessStatus": "Normal",
        "OppositeBandwidth": 12,
        "RouterType": "VRouter",
        "Role": "InitiatingSide",
        "HasReservationData": "false",
        "AccessPointId": "ap-cn-shanghaiSZ-****",
        "Ipv6Status": "on",
        "FastLinkMode": false,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParam.NotNull	The parameter must not be null.
400	EndPoint.Empty	the rc endpoint is empty.
400	InvalidConnectionType.MalFormed	Connection type must be vpc2vpc or vbr2vpc.
400	InvalidProductForm.MalFormed	Product form must be routerinterface or expressconnect.
400	InvalidRole.Malformed	role must be InitiatingSide or AcceptingSide.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
400	Parameter.Illegal	The parameter is illegal.	參數非法
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	指定的RegionId不存在
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	該過濾器的Key不支援：Filter.X.key。

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

變更歷史

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