Gunakan API GetGatewayConfig untuk inspeksi pengaturan gateway - MSE - Alibaba Cloud - Microservices Engine

Mengambil pengaturan parameter gerbang.

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

mse:GetGatewayConfig

get

*Gateway.

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	ID unik gerbang.	gw-61f465fa2dd044069e2208c4912*****
AcceptLanguage	string	No	Bahasa hasil yang dikembalikan. Nilai valid: zh (default): Chinese, en: English.	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult
RequestId	string	ID permintaan.	F6092602-C357-4750-89D9-E572FBEA****
Success	boolean	Apakah permintaan berhasil. Nilai valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true
Code	integer	Kode tanggapan yang disinkronkan dengan parameter Success.	200
ErrorCode	string	Kode kesalahan.	Success
HttpStatusCode	integer	Kode status HTTP.	200
Message	string	Paket tanggapan.	OK
DynamicCode	string	Tidak digunakan. Abaikan parameter ini.	code
DynamicMessage	string	Tidak digunakan. Abaikan parameter ini.	The specified parameter is invalid.
Data	object	Ikhtisar data.
GatewayUniqueId	string	ID unik gerbang.	gw-61f465fa2dd044069e2208c4912*****
EnableGenerateRequestId	boolean	Berlaku untuk cakupan (dalam OAuth) permintaan. Saat diaktifkan, ID permintaan dihasilkan di header permintaan untuk pelacakan permintaan.	true
EnableGzip	boolean	Berlaku untuk fase permintaan dan tanggapan. Mengaktifkan gzip mengompresi data permintaan dan tanggapan, yang mengurangi trafik gerbang tetapi meningkatkan konsumsi CPU gerbang.	false
EnableSlashMerge	boolean	Berlaku untuk fase permintaan. Menentukan apakah akan menggabungkan garis miring berlebihan dalam permintaan. Saat diaktifkan, garis miring berlebihan dalam www.a.com//b digabungkan, sehingga setara dengan www.a.com/b.	true
DownstreamIdleTime	integer	Berlaku untuk koneksi gerbang. Koneksi antara klien dan gerbang ditutup jika tidak ada permintaan yang diterima dalam periode yang ditentukan.	180
PreserveHeaderFormat	boolean	Berlaku untuk fase permintaan dan tanggapan. Menentukan apakah akan mempertahankan huruf besar/kecil asli header permintaan. Dalam spesifikasi HTTP/1.1, header tidak peka huruf besar/kecil. Untuk kompatibilitas HTTP/2, header dikonversi menjadi huruf kecil secara default.	true
DownstreamConnectionBufferLimits	integer	Berlaku untuk koneksi gerbang. Ukuran buffer per koneksi. Pengaturan ini memengaruhi throughput dan penggunaan memori gerbang. Unit: byte.	32768
EnableHardwareAccelerate	boolean	Menentukan apakah akan mengaktifkan akselerasi perangkat keras. Ini dapat gagal jika wilayah Anda tidak mendukungnya di tingkat infrastruktur atau jika akselerasi perangkat keras tidak ditentukan saat Port pengatur waktu pembelian.	true
XffTrustedNum	integer	Berlaku untuk fase permintaan. Jumlah proxy tepercaya di depan gerbang. Ini memengaruhi apakah gerbang menggunakan header permintaan yang dibuat klien seperti x-forwarded-for dan x-request-id.	0
EnableHttp2	boolean	Berlaku untuk fase permintaan. Menentukan apakah akan menggunakan HTTP/2 selama negosiasi antara server dan klien. Perubahan berlaku dalam 1 hingga 2 menit.	false
DownstreamHttp2MaxConcurrentStream	integer	Berlaku untuk fase permintaan. Jumlah maksimum aliran konkuren pada satu koneksi saat klien menggunakan HTTP/2.	100
InitialStreamWindowSize	integer	Berlaku untuk fase permintaan. Ukuran jendela aliran awal yang dinegosiasikan antara gerbang dan klien saat menggunakan HTTP/2. Unit: byte.	65535
InitialConnectionWindowSize	integer	Berlaku untuk fase permintaan. Ukuran jendela awal tingkat koneksi yang dinegosiasikan antara gerbang dan klien saat menggunakan HTTP/2. Unit: byte.	1048576
XtraceDetails	object	Informasi Analisis Tracing.
TraceOn	boolean	Indicates whether tracing analysis is enabled.	true
Id	integer	The trace ID.	255
Sample	integer	The sampling rate of tracing analysis. Unit: percentage (%).	100
GatewayId	integer	The gateway ID.	500
GatewayUniqueId	string	The unique ID of the gateway.	gw-61f465fa2dd044069e2208c4912*****
GmtCreate	string	The time when the information about tracing analysis was created.	2024-08-12T09:39:07.000+0000
GmtModified	string	The time when the information about tracing analysis was modified.	2024-08-12T09:39:07.000+0000
TraceType	string	The type of tracing analysis. Valid values: XTRACE: Managed Service for OpenTelemetry with the Zipkin protocol is used. SKYWALKING: Self-managed SkyWalking is used. OPENTELEMETRY: Managed Service for OpenTelemetry with the OpenTelemetry protocol is used. OTSKYWALKING: Managed Service for OpenTelemetry with the SkyWalking protocol is used.	OPENTELEMETRY
ServiceId	integer	The ID of the self-managed SkyWalking service.	333
ServicePort	string	The port number of the self-managed SkyWalking service.	8888
SlsConfigDetails	object	Informasi pengiriman log.
LogOn	boolean	Indicates whether log shipping is enabled.	true
Id	integer	This parameter is unavailable for use.	0
ProjectName	string	The name of the project for which log shipping is enabled.	test
LogStoreName	string	The name of the Logstore to which logs are shipped. If the NginxCompatible parameter is set to false, the Logstore name is mse_gw_access_log. If the NginxCompatible parameter is set to true, the Logstore name is nginx-ingress.	mse_gw_access_log
GatewayUniqueId	string	The unique ID of the gateway.	gw-61f465fa2dd044069e2208c4912*****
GatewayId	integer	The gateway ID.	500
GmtCreate	string	This parameter is unavailable for use.	""
GmtModified	string	This parameter is unavailable for use.	""
NginxCompatible	boolean	Indicates whether Microservices Engine (MSE) Ingress gateways are compatible with NGINX Ingress gateways.	false
SupportWaf	boolean	Apakah gerbang mendukung WAF.	true
EnableWaf	boolean	Apakah WAF diaktifkan.	true
AccessLogHeader	string	Format log kustom.	{"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}
EnableHttp3	boolean	Apakah HTTP/3 didukung.	false
UpstreamIdleTimeout	integer	Pengatur waktu idle default untuk koneksi upstream.	30
ZipAlgorithm	string	Algoritma kompresi yang digunakan saat kompresi diaktifkan. Anda dapat memilih brotli atau gzip. Jika EnableGzip tidak diaktifkan, itu akan diaktifkan secara otomatis saat parameter ini diatur.	["gzip"]
PathWithEscapedSlashes	string	Menentukan aksi untuk permintaan yang berisi karakter escape %2F, %2f, %5C, atau %5c di jalur URI. Nilai default adalah KEEP_UNCHANGED. Nilai valid: KEEP_UNCHANGED REJECT_REQUEST UNESCAPE_AND_REDIRECT UNESCAPE_AND_FORWARD	KEEP_UNCHANGED
NoSupportedConfigList	string	Daftar konfigurasi yang tidak didukung.	"EnableProxyProtocol,EnableCustomAuthConfigPush"
LogFilterConfig	string	Tidak tersedia untuk digunakan.	""
EnableProxyProtocol	boolean	Menentukan apakah akan mengaktifkan protokol Proxy. Jika trafik ingress gerbang diterima melalui NLB, alamat IP asal klien tidak dapat diperoleh tanpa mengaktifkan protokol ini. Mengaktifkannya tidak memengaruhi permintaan non-protokol Proxy.	true
EnableCustomAuthConfigPush	string	Berlaku untuk skenario yang menggunakan layanan otentikasi yang dikelola sendiri. Saat diaktifkan, perubahan pada aturan otentikasi tidak menyebabkan interupsi koneksi. Ini cocok untuk skenario WebSocket dan bisnis online.	false
KeepaliveHeaderTimeout	integer	Menentukan nilai yang digunakan untuk menghasilkan header respons Keep-Alive yang dikembalikan ke klien, yang menunjukkan laju keep-alive koneksi. Misalnya, jika diatur ke 10, header respons `keep-alive: timeout=10` dikembalikan. Jika diatur ke 0, header respons ini tidak dikembalikan.	0
WebsocketTermGracePeriod	integer	Pengatur waktu keep-alive yang dipertahankan untuk koneksi WebSocket saat instans gerbang perlu menutup koneksi selama peningkatan atau restart. Unit: detik.	30
EnableK8sSourceWorkloadFilter	object
Enable	boolean
LabelKey	string
LabelValue	string
FilterOpt	string
EnableXffTrustedCidrs	object
Enable	boolean
IpListContent	string
EnableGzipHardwareAccelerate	boolean
PreserveExternalRequestID	boolean
LiteMetrics	boolean
LogRequestResponseConfig	string

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F6092602-C357-4750-89D9-E572FBEA****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
    "EnableGenerateRequestId": true,
    "EnableGzip": false,
    "EnableSlashMerge": true,
    "DownstreamIdleTime": 180,
    "PreserveHeaderFormat": true,
    "DownstreamConnectionBufferLimits": 32768,
    "EnableHardwareAccelerate": true,
    "XffTrustedNum": 0,
    "EnableHttp2": false,
    "DownstreamHttp2MaxConcurrentStream": 100,
    "InitialStreamWindowSize": 65535,
    "InitialConnectionWindowSize": 1048576,
    "XtraceDetails": {
      "TraceOn": true,
      "Id": 255,
      "Sample": 100,
      "GatewayId": 500,
      "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
      "GmtCreate": "2024-08-12T09:39:07.000+0000",
      "GmtModified": "2024-08-12T09:39:07.000+0000",
      "TraceType": "OPENTELEMETRY",
      "ServiceId": 333,
      "ServicePort": "8888"
    },
    "SlsConfigDetails": {
      "LogOn": true,
      "Id": 0,
      "ProjectName": "test",
      "LogStoreName": "mse_gw_access_log",
      "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****\n",
      "GatewayId": 500,
      "GmtCreate": "\"\"",
      "GmtModified": " \"\"",
      "NginxCompatible": false
    },
    "SupportWaf": true,
    "EnableWaf": true,
    "AccessLogHeader": "{\"requestMetadata\":[],\"responseHeaders\":[],\"requestHeaders\":[\"x-test\"],\"responseMetadata\":[]}",
    "EnableHttp3": false,
    "UpstreamIdleTimeout": 30,
    "ZipAlgorithm": "[\"gzip\"]",
    "PathWithEscapedSlashes": "KEEP_UNCHANGED",
    "NoSupportedConfigList": "\"EnableProxyProtocol,EnableCustomAuthConfigPush\"",
    "LogFilterConfig": " \"\"",
    "EnableProxyProtocol": true,
    "EnableCustomAuthConfigPush": "false",
    "KeepaliveHeaderTimeout": 0,
    "WebsocketTermGracePeriod": 30,
    "EnableK8sSourceWorkloadFilter": {
      "Enable": false,
      "LabelKey": "",
      "LabelValue": "",
      "FilterOpt": ""
    },
    "EnableXffTrustedCidrs": {
      "Enable": false,
      "IpListContent": ""
    },
    "EnableGzipHardwareAccelerate": false,
    "PreserveExternalRequestID": false,
    "LiteMetrics": false,
    "LogRequestResponseConfig": ""
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.