DescribeRouterInterfaces - Express Connect - Alibaba Cloud Documentation Center

Mengkueri antarmuka router di wilayah tertentu.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeRouterInterfaces

list

*RouterInterface.

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID Wilayah antarmuka router. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID Wilayah.	cn-hangzhou
IncludeReservationData	boolean	No	Apakah akan menyertakan data perpanjangan. Nilai valid: true false (default)	false
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman saat melakukan paging. 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 hingga 5 kondisi filter. Kondisi filter berikut didukung: RouterInterfaceId: ID antarmuka router. RouterId: ID router. RouterType: Tipe router. Nilai valid: VRouter dan VBR. RouterInterfaceOwnerId: ID akun tempat antarmuka router berada. OppositeInterfaceId: ID antarmuka router peer. OppositeRouterType: Tipe antarmuka router peer. Nilai valid: VRouter dan VBR. OppositeRouterId: ID antarmuka router peer. OppositeInterfaceOwnerId: ID akun tempat antarmuka router peer berada. Status: Status antarmuka router. Name: Nama antarmuka router. Catatan Beberapa nilai dari setiap kondisi filter memiliki hubungan OR. Antarmuka router dikembalikan selama cocok dengan salah satu nilai. Kondisi filter memiliki hubungan AND. Antarmuka router hanya dikembalikan jika cocok dengan semua kondisi filter yang ditentukan.	Filter.1.Status
Value	array	No	Nilai filter berdasarkan Key yang ditentukan. Anda dapat menentukan beberapa nilai filter untuk sebuah Key. Nilai filter memiliki hubungan OR. Antarmuka router dikembalikan selama cocok dengan salah satu nilai filter.	Filter.1.Active 1
	string	No	Nilai filter berdasarkan Key yang ditentukan. Anda dapat menentukan beberapa nilai filter untuk sebuah Key. Nilai filter memiliki hubungan OR. Antarmuka router dikembalikan selama cocok dengan salah satu nilai filter.	test
ResourceGroupId	string	No	ID kelompok sumber daya. Untuk informasi lebih lanjut tentang kelompok sumber daya, lihat Apa itu kelompok sumber daya?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	Tag Sumber daya.
	object	No	Tag.
Key	string	No	Kunci tag Sumber daya. Anda harus menentukan setidaknya 1 kunci tag dan dapat menentukan hingga 20 kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 128 karakter. Tidak boleh dimulai dengan `aliyun` atau `acs:`, dan tidak boleh mengandung `http://` atau `https://`.	FinanceDept
Value	string	No	Nilai tag Sumber daya. Anda dapat menentukan hingga 20 nilai tag. Nilai tag dapat berupa string kosong. Panjang nilai tag maksimal 128 karakter. Tidak boleh dimulai dengan `aliyun` atau `acs:`, dan tidak boleh mengandung `http://` atau `https://`.	FinanceJoshua

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	Nomor halaman. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman saat melakukan paging. Nilai maksimum: 50. Nilai default: 10.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	Detail antarmuka router.
	array<object>	Detail antarmuka router.
ReservationActiveTime	string	Waktu aktif perpanjangan. Waktu mengikuti standar ISO 8601 dalam UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	Alamat IP target pemeriksaan kesehatan.	116.62.XX.XX
Status	string	Status antarmuka router.	active
CreationTime	string	Waktu pembuatan tabel rute. Waktu mengikuti standar ISO 8601 dalam UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
ReservationOrderType	string	Tipe pesanan perpanjangan.	RENEWCHANGE
OppositeInterfaceId	string	ID antarmuka router peer.	ri-bp1itx13bwe6f2wfh****
Spec	string	Spesifikasi antarmuka router.	Large
ChargeType	string	Metode penagihan.	PayByTraffic
RouterInterfaceId	string	ID antarmuka router.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	Ambang batas pemeriksaan kesehatan.	2
OppositeRouterType	string	Tipe router tempat antarmuka router peer berada.	VRouter
VpcInstanceId	string	ID VPC lokal dalam koneksi peering.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	ID akun tempat antarmuka router peer berada.	271598332402530847
OppositeVpcInstanceId	string	ID VPC peer.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	Tipe penagihan perpanjangan.	PayByBandwidth
CrossBorder	boolean	Apakah koneksi merupakan koneksi lintas batas.	false
Bandwidth	integer	Bandwidth antarmuka router. Unit: Mbit/s.	10
Description	string	Deskripsi antarmuka router.	Deskripsi antarmuka router
HcRate	integer	Laju pemeriksaan kesehatan.	1
ReservationBandwidth	string	Bandwidth perpanjangan. Unit: Mbit/s.	10
Name	string	Nama kustom.	test
OppositeRouterId	string	ID router tempat antarmuka router peer berada.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	Spesifikasi antarmuka router peer.	Large
RouterId	string	ID router tempat entri rute berada.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	Status bisnis antarmuka router peer.	Normal
ConnectedTime	string	Waktu ketika koneksi dibuat. Waktu mengikuti standar ISO 8601 dalam UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
HealthCheckSourceIp	string	Alamat IP sumber pemeriksaan kesehatan.	116.62.XX.XX
OppositeInterfaceStatus	string	Status antarmuka router peer.	Normal
EndTime	string	Waktu akhir data yang diambil. Waktu mengikuti standar ISO 8601 dalam UTC. Format: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
OppositeRegionId	string	ID Wilayah antarmuka router peer.	cn-shanghai
OppositeAccessPointId	string	ID titik akses peer.	ap-cn-shanghaiSZ-****
BusinessStatus	string	Status bisnis antarmuka router. Nilai valid: Normal: Normal. FinancialLocked: terkunci secara finansial. SecurityLocked: terkunci karena kontrol risiko keamanan.	Normal
OppositeBandwidth	integer	Bandwidth peer. Unit: Mbit/s.	12
RouterType	string	Tipe router tempat tabel rute berada. Nilai valid: VRouter: VPC vRouter. VBR: Virtual Border Router.	VRouter
Role	string	Peran dalam koneksi peering.	InitiatingSide
HasReservationData	string	Apakah data perpanjangan ada.	false
AccessPointId	string	ID titik akses.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Apakah perlindungan keamanan IPv6 diaktifkan. Nilai valid: on: diaktifkan. off: dinonaktifkan. unsupport: tidak didukung.	on
FastLinkMode	boolean	Apakah antarmuka router pada VBR dibuat dalam mode tautan cepat. Mode tautan cepat memungkinkan antarmuka router pada VBR dan VPC terhubung secara otomatis setelah dibuat. Nilai valid: true false (default)	false
ResourceGroupId	string	ID kelompok sumber daya. Untuk informasi lebih lanjut tentang kelompok sumber daya, lihat Apa itu kelompok sumber daya?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	Tag Sumber daya.
	object	Tag.
Key	string	Kunci tag Sumber daya.	FinanceDept
Value	string	Nilai tag Sumber daya.	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": "Deskripsi antarmuka router",
        "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	Description
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.	Parameter tidak valid.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	Parameter tidak valid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Kunci filter tidak didukung: Filter.X.key.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.