Kueri Gateway Privat melalui ListGateway API - Platform For AI - Alibaba Cloud - Platform For AI

Menampilkan daftar gerbang privat.

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

eas:ListGateway

list

*全部资源

*

None

Sintaks permintaan

GET /api/v2/gateways HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
GatewayId	string	No	ID gerbang privat. Anda dapat memperoleh ID dari bidang private_gateway_id pada tanggapan operasi ListResources.	gw-1uhcqmsc7x22******
PageNumber	integer	No	Nomor halaman daftar gerbang yang akan dikembalikan. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah gerbang yang akan dikembalikan pada setiap halaman. Nilai default adalah 100.	100
GatewayName	string	No	Alias gerbang privat.	mygateway1
ResourceName	string	No	ID kelompok sumber daya. Anda dapat memperoleh ID dari bidang ResourceId pada tanggapan operasi ListResources.	eas-r-4gt8twzwllfo******
InternetEnabled	boolean	No	Apakah akan mengaktifkan akses melalui jaringan publik.	true
Status	string	No	Status gerbang.	Running
ChargeType	string	No	Metode penagihan. Valid values: PostPaid : Pay-as-you-go. PrePaid : Langganan.	PrePaid
Sort	string	No	Bidang untuk pengurutan. Valid values: Status : Status. ChargeType : Metode penagihan. CreateTime : Pengatur waktu pembuatan. UpdateTime : Pengatur waktu pembaruan. InternetEnabled : Akses jaringan publik. GatewayType : Tipe gerbang. GatewayName : Nama gerbang.	CreateTime
Order	string	No	Pesanan. Valid values: asc : Menaik. desc : Menurun.	asc
GatewayType	string	No	Tipe gerbang. Valid values: FullyManaged : Gerbang khusus terkelola penuh. Application : Gerbang khusus aplikasi.	Application
Label	object	No	Filter berdasarkan tag.
	string	No	The tag to filter by, in {"key":"value"} format. You can set the value to null or an empty string to filter only by the key.	{"key1":"value1","key2":null}

Elemen respons

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	40325405-579C-4D82****
Gateways	array<object>	The list of private gateways.
	array<object>	The details of the private gateway.
GatewayId	string	The ID of the private gateway.	gw-1uhcqmsc7x22******
GatewayName	string	The alias of the private gateway.	mygateway1
InstanceType	string	The instance type used by the private gateway.	2c4g
IntranetDomain	string	The internal network endpoint.	gw-1uhcqmsc7x22****-1801786532****-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabled	boolean	Indicates whether public network access is enabled.	true
InternetDomain	string	The public network endpoint.	gw-1uhcqmsc7x22****-1801786532****.cn-wulanchabu.pai-eas.aliyuncs.com
CreateTime	string	The time when the private gateway was created. The time is in UTC.	2020-05-19T14:19:42Z
UpdateTime	string	The time when the private gateway was last updated. The time is in UTC.	2021-02-24T11:52:17Z
Status	string	The status of the private gateway. Valid values: Creating : The gateway is being created. Stopped : The gateway is stopped. Failed : The gateway has failed. Running : The gateway is running. Deleted : The gateway is deleted. Deleting : The gateway is being deleted. Waiting : The gateway is waiting.	Running
Replicas	integer	The number of nodes for the private gateway.	2
IsDefault	boolean	Indicates whether it is the default private gateway.	true
ChargeType	string	The billing method. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go.	PostPaid
SSLRedirectionEnabled	boolean	Indicates whether HTTP to HTTPS redirection is enabled.	true
IntranetEnabled	boolean	Indicates whether internal network access is enabled.
Labels	array<object>	The list of gateway tags.
	object	The gateway tag object.
LabelKey	string		key1
LabelValue	string		value1
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	100
TotalCount	integer	The total number of gateways.	5

Contoh

Respons sukses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true,
      "IntranetEnabled": false,
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.