Konfigurasi opsi gateway MSE menggunakan UpdateGatewayOption API-Microservices Engine-Alibaba Cloud - Microservices Engine

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

update

*Gateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GatewayId	integer	No	ID gerbang.	421
GatewayOption	GatewayOption	No	Konfigurasi terperinci gerbang. TraceDetails: deskripsi pengambilan sampel Managed Service for OpenTelemetry. Konten: TraceEnabled menunjukkan apakah Managed Service for OpenTelemetry diaktifkan. Sample menunjukkan laju pengambilan sampel Managed Service for OpenTelemetry. LogConfigDetails: deskripsi Simple Log Service. Konten: LogEnabled menunjukkan apakah Simple Log Service diaktifkan. ProjectName menunjukkan Proyek Simple Log Service tempat log dikirim. LogStoreName menunjukkan nama penyimpanan log. EnableHardwareAcceleration: menunjukkan apakah akselerasi perangkat keras diaktifkan. DisableHttp2Alpn: menunjukkan apakah protokol HTTP/2 dinonaktifkan. EnableWaf: menunjukkan apakah Web Application Firewall (WAF) diaktifkan.
GatewayUniqueId	string	Yes	ID unik gerbang.	gw-83b0ddb569434f82b9fe8e4c60c4****
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Bahasa Tionghoa en: Bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	124D02EB-DBDD-534D-A701-B4A95D3D****
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.	The request is successfully processed.
Code	integer	The status code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	GatewayOption	The data returned.	{'LogConfigDetails': {'LogEnabled': True}, 'TraceDetails': {'Sample': 17, 'TraceEnabled': True}}

Contoh

Respons sukses

JSONformat

{
  "RequestId": "124D02EB-DBDD-534D-A701-B4A95D3D****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "TraceDetails": {
      "TraceEnabled": true,
      "Sample": 10,
      "TraceType": "XTRACE",
      "ServiceId": 10458,
      "ServicePort": "80"
    },
    "LogConfigDetails": {
      "LogEnabled": true,
      "ProjectName": "project",
      "LogStoreName": "name"
    },
    "EnableHardwareAcceleration": true,
    "DisableHttp2Alpn": true,
    "EnableWaf": true
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.