DescribeVirtualBorderRouters - Express Connect - Alibaba Cloud Documentation Center

Mengkueri instans Virtual Border Router (VBR) yang telah Anda buat.

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:DescribeVirtualBorderRouters

list

*VirtualBorderRouter

acs:vpc:{#regionId}:{#AccountId}:virtualborderrouter/{#VbrId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah VBR. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.	cn-shanghai
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri berhalaman. 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: PhysicalConnectionId: ID instans sirkuit Express Connect. VbrId: ID instans Virtual Border Router. Status: status Virtual Border Router. Name: nama Virtual Border Router. AccessPointId: ID instans titik akses. eccId: ID instans Express Cloud Connect. type: tipe sirkuit Express Connect.	Status
Value	array	No	Nilai filter berdasarkan Key yang ditentukan. Anda dapat menentukan beberapa nilai filter untuk sebuah Key. Hubungan antar nilai filter adalah OR, yang berarti kecocokan ditemukan jika salah satu nilai filter terpenuhi.	Active
	string	No	Nilai filter berdasarkan Key yang ditentukan. Anda dapat menentukan beberapa nilai filter untuk sebuah Key. Hubungan antar nilai filter adalah OR, yang berarti kecocokan ditemukan jika salah satu nilai filter terpenuhi.	Active
IncludeCrossAccountVbr	boolean	No	Apakah akan menyertakan Virtual Border Router lintas akun. true: Disertakan. false (default): Tidak disertakan.	false
ResourceGroupId	string	No	ID kelompok sumber daya. Untuk informasi selengkapnya 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 dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag 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 dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	FinanceJoshua

Elemen respons

Element	Type	Description	Example
	object	Informasi VBR.
RequestId	string	ID permintaan.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumber	integer	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman dalam kueri berhalaman. Nilai maksimum: 50. Nilai default: 10.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	1
VirtualBorderRouterSet	object
VirtualBorderRouterType	array<object>	Daftar VBR yang dikueri.
	array<object>	Pengatur waktu pembuatan VBR.
CreationTime	string	Pengatur waktu pembuatan VBR.	2020-06-08T12:20:55
Status	string	Status VBR. unconfirmed: VBR menunggu konfirmasi. active: VBR normal. terminating: VBR sedang dihentikan. terminated: VBR telah dihentikan. recovering: VBR sedang dipulihkan. deleting: VBR sedang dihapus.	active
Type	string	Tipe VBR.	pconnVBR
MinTxInterval	integer	Interval pengiriman paket Bidirectional Forwarding Detection (BFD). Nilai valid: 200 hingga 1000. Unit: milidetik.	300
PeerIpv6GatewayIp	string	Alamat IPv6 sisi pelanggan dari VBR.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PConnVbrExpireTime	string	Pengatur waktu kedaluwarsa VBR pay-as-you-go.	2021-06-08T12:20:55
PhysicalConnectionOwnerUid	string	ID akun tempat sirkuit Express Connect berada.	1688000000000****
ActivationTime	string	Pengatur waktu pertama kali VBR diaktifkan.	2021-06-08T12:20:55
PhysicalConnectionBusinessStatus	string	Status bisnis sirkuit Express Connect. Normal: normal. FinancialLocked: terkunci karena pembayaran tertunda.	Normal
Description	string	Deskripsi VBR.	desc
TerminationTime	string	Pengatur waktu terakhir VBR dihentikan.	2021-06-08T12:20:55
MinRxInterval	integer	Interval penerimaan paket BFD. Nilai valid: 200 hingga 1000. Unit: milidetik.	300
PeerGatewayIp	string	Alamat IPv4 sisi pelanggan dari VBR.	192.168.XX.XX
Name	string	Nama VBR.	test
VbrId	string	ID VBR.	vbr-bp1jcg5cmxjbl9xgc****
VlanId	integer	ID VLAN VBR.	10
VlanInterfaceId	string	ID antarmuka router VBR.	ri-2zeo3xzyf38r4xx****
CircuitCode	string	Kode sirkuit yang disediakan oleh penyedia layanan Internet (ISP) untuk sirkuit Express Connect.	longtel0****
LocalIpv6GatewayIp	string	Alamat IPv6 sisi Alibaba Cloud dari VBR.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalGatewayIp	string	Alamat IPv4 sisi Alibaba Cloud dari VBR.	192.168.XX.XX
PeeringSubnetMask	string	Mask subnet alamat IPv4 sisi Alibaba Cloud dan alamat IPv4 sisi pelanggan dari VBR.	255.255.255.252
EnableIpv6	boolean	Apakah IPv6 diaktifkan. true: diaktifkan. false: dinonaktifkan.	false
RouteTableId	string	ID tabel entri rute VBR.	rtb-bp1****
DetectMultiplier	integer	Pengganda pengatur waktu deteksi. Pengganda menentukan jumlah maksimum paket yang boleh hilang dari pengirim ke penerima untuk mendeteksi apakah tautan berfungsi. Nilai valid: 3 hingga 10.	3
EccId	string	ID instans Express Cloud Connect (ECC).	ecc-h****
CloudBoxInstanceId	string	ID instans CloudBox.	cb-****
RecoveryTime	string	Pengatur waktu terakhir VBR dipulihkan dari status terminated ke status active.	2021-05-08T12:20:55
PhysicalConnectionStatus	string	Status sirkuit Express Connect. Initial: Sirkuit Express Connect sedang diajukan. Approved: Sirkuit Express Connect telah disetujui. Allocating: Sumber daya sedang dialokasikan. Allocated: Sirkuit Express Connect sedang dalam pembangunan. Confirmed: Sirkuit Express Connect menunggu konfirmasi pengguna. Enabled: Sirkuit Express Connect telah diaktifkan. Rejected: Aplikasi ditolak. Canceled: Sirkuit Express Connect dibatalkan. Allocation Failed: Alokasi sumber daya gagal. Terminated: Sirkuit Express Connect telah dihentikan.	Normal
PeeringIpv6SubnetMask	string	Mask subnet alamat IPv6 sisi Alibaba Cloud dan alamat IPv6 sisi pelanggan dari VBR.	2000:1234:0:a000::/55
AccessPointId	string	ID titik akses sirkuit Express Connect.	ap-cn-kojok1x****
PConnVbrChargeType	string	Metode penagihan VBR yang terikat pada sirkuit Express Connect. PrePaid: langganan. Jika Anda menggunakan metode penagihan ini, pastikan akun Anda mendukung pembayaran saldo atau pembayaran kredit. PostPaid: pay-as-you-go.	PrePaid
PhysicalConnectionId	string	ID sirkuit Express Connect tempat VBR berada.	pc-119mfjzm7x****
AssociatedPhysicalConnections	object
AssociatedPhysicalConnection	array<object>	Informasi tentang sirkuit Express Connect yang terkait.
	object	Informasi tentang sirkuit Express Connect yang terkait.
Status	string	Status VBR. unconfirmed: VBR menunggu konfirmasi. active: VBR normal. terminating: VBR sedang dihentikan. terminated: VBR telah dihentikan. recovering: VBR sedang dipulihkan. deleting: VBR sedang dihapus.	active
VlanInterfaceId	string	ID antarmuka router VBR. Antarmuka ini dapat digunakan sebagai lompatan berikutnya untuk entri rute VBR.	ri-kojok19x3j0q6k****
CircuitCode	string	Kode sirkuit yang disediakan oleh penyedia layanan Internet (ISP) untuk sirkuit Express Connect.	longtel0**
PeerIpv6GatewayIp	string	Alamat IPv6 sisi pelanggan dari VBR.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalIpv6GatewayIp	string	Alamat IPv6 sisi Alibaba Cloud dari VBR.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PhysicalConnectionOwnerUid	string	ID akun tempat sirkuit Express Connect berada.	12345678****
LocalGatewayIp	string	Alamat IPv4 sisi Alibaba Cloud dari VBR.	192.168.XX.XX
PhysicalConnectionBusinessStatus	string	Status bisnis sirkuit Express Connect. Normal: normal. FinancialLocked: terkunci karena pembayaran tertunda.	Normal
PeeringSubnetMask	string	Mask subnet alamat IPv4 sisi Alibaba Cloud dan alamat IPv4 sisi pelanggan dari VBR. Kedua alamat IPv4 harus berada dalam subnet yang sama.	255.255.255.252
EnableIpv6	boolean	Apakah IPv6 diaktifkan. true: diaktifkan. false: dinonaktifkan.	true
PhysicalConnectionStatus	string	Status sirkuit Express Connect. Initial: Sirkuit Express Connect sedang diajukan. Approved: Sirkuit Express Connect telah disetujui. Allocating: Sumber daya sedang dialokasikan. Allocated: Sirkuit Express Connect sedang dalam pembangunan. Confirmed: Sirkuit Express Connect menunggu konfirmasi pengguna. Enabled: Sirkuit Express Connect telah diaktifkan. Rejected: Aplikasi ditolak. Canceled: Sirkuit Express Connect dibatalkan. Allocation Failed: Alokasi sumber daya gagal. Terminated: Sirkuit Express Connect telah dihentikan.	Enabled
PeerGatewayIp	string	Alamat IPv4 sisi pelanggan dari VBR.	116.62.XX.XX
PeeringIpv6SubnetMask	string	Mask subnet alamat IPv6 sisi Alibaba Cloud dan alamat IPv6 sisi pelanggan dari VBR. Kedua alamat IPv6 harus berada dalam subnet yang sama.	2408:4004:cc:400::/56
PhysicalConnectionId	string	ID sirkuit Express Connect.	pc-119mfjzm7****
VlanId	string	ID VLAN VBR.	0
AssociatedCens	object
AssociatedCen	array<object>	Informasi tentang instans Cloud Enterprise Network (CEN) yang terkait.
	object	Informasi instans.
CenOwnerId	integer	ID akun tempat instans CEN berada.	1688000000000****
CenId	string	ID instans CEN.	cen-kojok19xxx****
CenStatus	string	Status instans CEN. Attached: terpasang. Attaching: sedang dipasang. Detached: dilepas. Detaching: sedang dilepas. Empty: tidak terpasang.	Attached
Bandwidth	integer	Bandwidth VBR. Unit: Mbit/s.	50
ResourceGroupId	string	ID kelompok sumber daya. Untuk informasi selengkapnya 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.	FinanceDept
Value	string	Nilai tag.	FinanceJoshua
EcrId	string	ID instans Express Connect Router (ECR) yang terkait.	ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnable	boolean	Apakah akses bisnis antar pusat data (IDC) diizinkan. Nilai valid: true: ya. false: tidak. Catatan Jika Anda tidak menentukan nilai, akses bisnis antar IDC tidak diizinkan.	false
EcrAttatchStatus	string	Status asosiasi ECR. Attached: terpasang. Attaching: sedang dipasang. Detached: dilepas. Detaching: sedang dilepas. Empty: tidak terpasang.	Attached
EcrOwnerId	string	ID akun Alibaba Cloud (akun utama) tempat instans ECR berada.	192732132151xxxx
Mtu	integer	Maximum transmission unit (MTU) yang didukung oleh VBR. Nilai valid: 1500 dan 8500.	1500

Contoh

Respons sukses

JSONformat

{
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "CreationTime": "2020-06-08T12:20:55",
        "Status": "active",
        "Type": "pconnVBR",
        "MinTxInterval": 300,
        "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "PConnVbrExpireTime": "2021-06-08T12:20:55",
        "PhysicalConnectionOwnerUid": "1688000000000****",
        "ActivationTime": "2021-06-08T12:20:55",
        "PhysicalConnectionBusinessStatus": "Normal",
        "Description": "desc",
        "TerminationTime": "2021-06-08T12:20:55",
        "MinRxInterval": 300,
        "PeerGatewayIp": "192.168.XX.XX",
        "Name": "test",
        "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
        "VlanId": 10,
        "VlanInterfaceId": "ri-2zeo3xzyf38r4xx****",
        "CircuitCode": "longtel0****",
        "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "LocalGatewayIp": "192.168.XX.XX",
        "PeeringSubnetMask": "255.255.255.252",
        "EnableIpv6": false,
        "RouteTableId": "rtb-bp1****",
        "DetectMultiplier": 3,
        "EccId": "ecc-h****",
        "CloudBoxInstanceId": "cb-****",
        "RecoveryTime": "2021-05-08T12:20:55",
        "PhysicalConnectionStatus": "Normal",
        "PeeringIpv6SubnetMask": "2000:1234:0:a000::/55",
        "AccessPointId": "ap-cn-kojok1x****",
        "PConnVbrChargeType": "PrePaid",
        "PhysicalConnectionId": "pc-119mfjzm7x****",
        "AssociatedPhysicalConnections": {
          "AssociatedPhysicalConnection": [
            {
              "Status": "active",
              "VlanInterfaceId": "ri-kojok19x3j0q6k****",
              "CircuitCode": "longtel0**",
              "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "PhysicalConnectionOwnerUid": "12345678****",
              "LocalGatewayIp": "192.168.XX.XX",
              "PhysicalConnectionBusinessStatus": "Normal",
              "PeeringSubnetMask": "255.255.255.252",
              "EnableIpv6": true,
              "PhysicalConnectionStatus": "Enabled",
              "PeerGatewayIp": "116.62.XX.XX",
              "PeeringIpv6SubnetMask": "2408:4004:cc:400::/56",
              "PhysicalConnectionId": "pc-119mfjzm7****",
              "VlanId": "0"
            }
          ]
        },
        "AssociatedCens": {
          "AssociatedCen": [
            {
              "CenOwnerId": 0,
              "CenId": "cen-kojok19xxx****",
              "CenStatus": "Attached"
            }
          ]
        },
        "Bandwidth": 50,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "EcrId": "ecr-7vrbqv9lcgvzqbwwkm",
        "SitelinkEnable": false,
        "EcrAttatchStatus": "Attached",
        "EcrOwnerId": "192732132151xxxx",
        "Mtu": 1500
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.	Unknown error. Try again later. If the error persists, submit a ticket.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The specified RegionId does not exist.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	The Key of this filter is not supported: Filter.X.key.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.