DescribeRouterInterfaces - Virtual Private Cloud - Alibaba Cloud Documentation Center

Mengkueri antarmuka router di region yang ditentukan dengan memanggil operasi DescribeRouterInterfaces.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region tempat antarmuka router berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar region terbaru.	cn-hangzhou
IncludeReservationData	boolean	No	Menentukan apakah akan menyertakan data perpanjangan. Nilai yang valid: true: ya. false (default): tidak.	false
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan per halaman. Nilai maksimum: 50. Nilai default: 10.	10
Filter	array<object>	No	Informasi filter.
	object	No	Informasi filter.
Key	string	No	Kondisi filter. Anda dapat menentukan maksimum lima kondisi filter. Kondisi filter berikut didukung: RouterInterfaceId: ID antarmuka router. RouterId: ID router. RouterType: jenis router. Nilai yang valid: VRouter dan VBR. RouterInterfaceOwnerId: ID akun pemilik antarmuka router. OppositeInterfaceId: ID antarmuka router peer. OppositeRouterType: jenis antarmuka router peer. Nilai yang valid: VRouter dan VBR. OppositeRouterId: ID antarmuka router peer. OppositeInterfaceOwnerId: ID akun pemilik antarmuka router peer. Status: status antarmuka router. Name: nama antarmuka router. Catatan Hubungan logis antara beberapa nilai pada satu kondisi filter adalah OR. Kondisi filter terpenuhi jika ada nilai yang cocok dengan kondisi filter yang ditentukan. Hubungan logis antara beberapa kondisi filter adalah AND. Hanya entri yang memenuhi semua kondisi filter yang ditentukan yang akan disertakan dalam hasil kueri akhir.	Filter.1.Status
Value	array	No	Menentukan nilai filter berdasarkan Key. Satu Key mendukung beberapa nilai filter. Hubungan logis antara beberapa nilai filter adalah OR. Kondisi filter terpenuhi jika ada nilai filter yang cocok.	Filter.1.Active 1
	string	No	Menentukan nilai filter berdasarkan Key. Satu Key mendukung beberapa nilai filter. Hubungan logis antara beberapa nilai filter adalah OR. Kondisi filter terpenuhi jika ada nilai filter yang cocok.	test
ResourceGroupId	string	No	ID grup sumber daya. Untuk informasi lebih lanjut tentang grup sumber daya, lihat Apa itu grup sumber daya?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	Tag dari sumber daya.
	object	No	Tag.
Key	string	No	Kunci tag. Anda harus memasukkan setidaknya satu kunci tag dan maksimum 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Kunci tag dapat berisi hingga 128 karakter. Kunci tag tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh berisi `http://` atau `https://`.	FinanceDept
Value	string	No	Nilai tag. Anda dapat memasukkan hingga 20 nilai tag. Nilai tag dapat berupa string kosong. Nilai tag dapat berisi hingga 128 karakter. Nilai tag tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh berisi `http://` atau `https://`.	FinanceJoshua

Elemen respons

Element	Type	Description	Example
	object	Informasi respons.
RequestId	string	ID permintaan.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	Nomor halaman. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman. Nilai maksimum: 50. Nilai default: 10.	10
TotalCount	integer	Jumlah entri yang dikembalikan.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	Detail antarmuka router.
	array<object>	Detail antarmuka router.
ReservationActiveTime	string	The time when the renewal takes effect. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	The destination IP address that is used for the health check.	116.62.XX.XX
Status	string	The status of the router interface.	active
CreationTime	string	The time when the route table was created. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.	2021-06-08T12:20:55
ReservationOrderType	string	The type of the renewal order. Valid values:	RENEWCHANGE
OppositeInterfaceId	string	The ID of the peer router interface.	ri-bp1itx13bwe6f2wfh****
Spec	string	The specification of the router interface.	Large
ChargeType	string	The billing method.	PayByTraffic
RouterInterfaceId	string	The ID of the router interface.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	The health check threshold.	2
OppositeRouterType	string	The type of the router to which the peer router interface belongs.	VRouter
VpcInstanceId	string	The ID of the local virtual private cloud (VPC) in the peering connection.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	The ID of the Alibaba Cloud account to which the peer router interface belongs.	271598332402530847
OppositeVpcInstanceId	string	The ID of the peer VPC.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	The metering method that is used after the renewal takes effect. Valid values:	PayByBandwidth
CrossBorder	boolean	Indicates whether the connection is a cross-border connection.	false
Bandwidth	integer	The bandwidth of the router interface. Unit: Mbit/s.	10
Description	string	The description of the router interface.	路由表接口描述
HcRate	integer	The rate of heath checks.	1
ReservationBandwidth	string	The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.	10
Name	string	The custom name.	test
OppositeRouterId	string	The ID of the router to which the peer router interface belongs.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	The specification of the peer router interface.	Large
RouterId	string	The ID of the router to which the route entry belongs.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	The service status of the peer router interface.	Normal
ConnectedTime	string	The time when the connection was established. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.	2021-06-08T12:20:55
HealthCheckSourceIp	string	The source IP address that is used for the health check.	116.62.XX.XX
OppositeInterfaceStatus	string	The status of the peer router interface.	Normal
EndTime	string	The end of the time range during which data was queried. The time follows the ISO8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.	2021-06-08T12:20:55
OppositeRegionId	string	The region ID of the peer router interface.	cn-shanghai
OppositeAccessPointId	string	The ID of the peer access point.	ap-cn-shanghaiSZ-****
BusinessStatus	string	The service status of the router interface. Valid values: Normal FinancialLocked SecurityLocked	Normal
OppositeBandwidth	integer	The maximum bandwidth of the peer router interface. Unit: Mbit/s.	12
RouterType	string	The type of the router to which the route table belongs. Valid values: VRouter VBR	VRouter
Role	string	Indicates whether the router interface is the initiator or acceptor of the peering connection.	InitiatingSide
HasReservationData	string	Indicates whether renewal data is included.	false
AccessPointId	string	The ID of the access point.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Indicates whether protection against malicious IPv6 traffic is enabled. Valid values: on off unsupport	on
FastLinkMode	boolean	Indicates whether the VBR that is created in the Fast Link mode is uplinked to the router interface. The Fast Link mode helps automatically connect router interfaces that are created for the VBR and its peer VPC. Valid values: true false (default)	false
ResourceGroupId	string	Resource Group ID. For more information about resource groups, please refer to What is a Resource Group?	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	The tags of the resource.
	object
Key	string	The key of the resource tag. At least one tag key must be entered, and a maximum of 20 tag keys are supported. If this value needs to be passed in, it cannot be an empty string. A tag key can support up to 128 characters, cannot start with 'aliyun' or 'acs:', and cannot contain 'http://' or 'https://'.	FinanceDept
Value	string	The value of the resource tag. A maximum of 20 tag values can be entered. If this value needs to be passed in, an empty string can be entered. A maximum of 128 characters are supported, it cannot start with 'aliyun' or 'acs:', and it cannot contain 'http://' or 'https://'.	FinanceJoshua

Contoh

Respons sukses

JSONformat

{
  "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"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
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.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.