DescribeCustomerGateways - VPN Gateway - Alibaba Cloud Documentation Center

Mengkueri informasi tentang customer gateway.

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

list

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/*

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID region customer gateway. Anda dapat memanggil DescribeRegions untuk mengkueri ID region.	cn-shanghai
CustomerGatewayId	string	No	ID instans customer gateway. Catatan Jika Anda tidak menentukan ID instans customer gateway, sistem akan mengkueri informasi tentang semua customer gateway di region saat ini secara default.	cgw-bp1pvpl9r9adju6l5****
PageNumber	integer	No	Nomor halaman daftar. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman dalam kueri berpaginasi. Nilai maksimum: 50. Nilai default: 10.	10
Tag	array<object>	No	Daftar tag yang terikat pada customer gateway.
	object	No	Informasi tag.
Key	string	No	Kunci tag. Jika Anda menentukan parameter ini, nilainya tidak boleh berupa string kosong. Kunci tag dapat memiliki panjang hingga 64 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`. Anda dapat menentukan hingga 20 kunci tag sekaligus.	TagKey
Value	string	No	Nilai tag. Nilai tag dapat memiliki panjang hingga 128 karakter dan dapat berupa string kosong. Nilai tag tidak boleh dimulai dengan `aliyun` atau `acs:` dan tidak boleh mengandung `http://` atau `https://`. Setiap kunci tag sesuai dengan satu nilai tag. Anda dapat menentukan hingga 20 nilai tag sekaligus.	TagValue
ResourceGroupId	string	No	ID grup sumber daya tempat customer gateway berada. Anda dapat memanggil ListResourceGroups untuk mengkueri ID grup sumber daya.	rg-acfmzs372yg****

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
PageSize	integer	Jumlah entri per halaman dalam kueri berpaginasi.	10
RequestId	string	ID permintaan.	E82612A9-CB90-4D7E-B394-1DB7F6509B29
PageNumber	integer	Nomor halaman daftar.	1
TotalCount	integer	Jumlah total entri dalam daftar.	1
CustomerGateways	object
CustomerGateway	array<object>	Daftar customer gateway.
	array<object>	Informasi tentang customer gateway.
IpAddress	string	Alamat IP perangkat gateway data center lokal.	139.32.XX.XX
Asn	integer	Nomor sistem otonom (ASN) perangkat gateway data center lokal.	65530
Description	string	Informasi deskripsi customer gateway.	desctest
CustomerGatewayId	string	ID instance customer gateway.	cgw-bp1pvpl9r9adju6l5****
CreateTime	integer	Timestamp pembuatan customer gateway. Satuan: milidetik. Format timestamp menggunakan Unix timestamp, yang menunjukkan total durasi dari 00:00:00 Waktu Greenwich pada tanggal 1 Januari 1970 hingga waktu pembuatan customer gateway.	1492747187000
Name	string	Nama customer gateway.	nametest
AuthKey	string	Kunci autentikasi protokol routing BGP perangkat gateway data center lokal.	AuthKey****
Tags	object
Tag	array<object>	Daftar tag yang terikat pada customer gateway.
	object	Informasi tag.
Key	string	Kunci tag.	TagKey
Value	string	Nilai tag.	TagValue
ResourceGroupId	string	ID resource group tempat customer gateway berada. Anda dapat memanggil antarmuka ListResourceGroups untuk mengkueri informasi resource group.	rg-acfmzs372yg****

Contoh

Respons sukses

JSONformat

{
  "PageSize": 10,
  "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber": 1,
  "TotalCount": 1,
  "CustomerGateways": {
    "CustomerGateway": [
      {
        "IpAddress": "139.32.XX.XX",
        "Asn": 65530,
        "Description": "desctest",
        "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
        "CreateTime": 1492747187000,
        "Name": "nametest",
        "AuthKey": "AuthKey****",
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	Sumber daya tag duplikat
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	Jumlah tag melebihi batas
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	Parameter TagValue yang ditentukan tidak sesuai dengan spesifikasi.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	Parameter TagKey yang ditentukan tidak sesuai dengan spesifikasi.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	Parameter TagKey yang ditentukan duplikat.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	Anda tidak memiliki izin untuk mengoperasikan sumber daya yang ditentukan, harap ajukan izin sebelum melakukan operasi.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.