All Products
Search

This Product

    Microservices Engine:UpdateGatewayAuth

    Document Center

    Microservices Engine:UpdateGatewayAuth

    Last Updated:Jul 28, 2026

    Memperbarui otentikasi 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:UpdateGatewayAuth

    update

    *Gateway.

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    No

    Nama otentikasi.

    test.
    Type

    string

    No

    Tipe otentikasi. Nilai valid:

    ExternalAuthZ.
    Issuer

    string

    No

    Digunakan ketika tipe otentikasi adalah JWT atau OIDC:

    test.
    Jwks

    string

    No

    Kunci publik JWT. Format JSON didukung.

    {"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
    TokenPosition

    string

    No

    Tipe token JWT. Nilai valid:

    HEADER.
    TokenName

    string

    No

    Lokasi penyimpanan token JWT.

    Authorization.
    TokenNamePrefix

    string

    No

    Awalan token JWT.

    Bearer.
    TokenPass

    boolean

    No

    Apakah akan meneruskan token.

    true.
    Status

    boolean

    No

    Status pengaktifan. Nilai valid:

    true.
    Id

    integer

    No

    ID aturan otentikasi.

    719
    RedirectUrl

    string

    No

    URL pengalihan setelah otorisasi berhasil. Parameter ini digunakan untuk OIDC/IDaaS dan harus konsisten dengan URL pengalihan yang dikonfigurasi di OIDC/IDaaS.

    https://test-.com/oauth2/callback.
    ClientId

    string

    No

    ID aplikasi yang terdaftar dengan layanan. Parameter ini digunakan untuk OIDC/IDaaS.

    app_mnvxaavggw7hcdcnr6usi6***
    ClientSecret

    string

    No

    Rahasia aplikasi yang terdaftar dengan layanan otentikasi OIDC.

    CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
    CookieDomain

    string

    No

    Nama domain cookie. Setelah otentikasi berhasil, cookie dikirim ke nama domain yang ditentukan untuk mempertahankan status login.

    test.com.
    ScopesList

    array

    No

    Cakupan otorisasi OIDC. Parameter ini digunakan untuk OIDC.

    string

    No

    Cakupan otorisasi OIDC. Parameter ini digunakan untuk OIDC.

    openid.
    LoginUrl

    string

    No

    URL halaman login pengguna dari instans IDaaS. Parameter ini digunakan untuk IDaaS.

    https://daxxxxcn.aliyunidaas.com/
    Sub

    string

    No

    Digunakan ketika tipe otentikasi adalah JWT. sub (subject) dalam klaim JWT, yang menentukan Pihak yang berwenang. Pastikan nilai bidang sub dalam muatan JWT konsisten dengan nilai yang dikonfigurasi di sini. Jika parameter ini tidak diatur atau kosong, nilai defaultnya adalah nilai parameter Issuer.

    example-app.
    ExternalAuthZJSON

    object

    No

    Informasi otentikasi kustom.

    ServiceId

    integer

    No

    ID layanan otentikasi.

    37396
    PrefixPath

    string

    No

    Jalur API otentikasi yang disediakan oleh layanan otentikasi. Jalur API harus menggunakan pencocokan awalan.

    /auth.
    TokenKey

    string

    No

    Header tempat token berada dalam Paket permintaan. Nilai umum meliputi Authorization dan Cookie.

    Authorization.
    AllowRequestHeaders

    array

    No

    Nama header permintaan yang diizinkan.

    string

    No

    Nama header permintaan yang diizinkan.

    x-req.
    AllowUpstreamHeaders

    array

    No

    Nama header respons yang diizinkan.

    string

    No

    Nama header respons yang diizinkan.

    x-resp.
    Timeout

    integer

    No

    Periode waktu tunggu layanan otentikasi. Unit: detik.

    10
    IsRestrict

    boolean

    No

    Mode otentikasi kustom. Nilai valid:

    true.
    WithRequestBody

    boolean

    No

    Apakah akan mengizinkan pembawaan body.

    true.
    BodyMaxBytes

    integer

    No

    Jumlah byte maksimum untuk body.

    4000000
    WithRematchRoute

    boolean

    No

    Apakah akan mencocokkan ulang rute setelah otentikasi selesai.

    true.
    GatewayUniqueId

    string

    No

    ID unik gerbang.

    gw-9cdcf8e4f58144059e73ff4c5ef9****
    IsWhite

    boolean

    No

    Mode blacklist/daftar putih otorisasi. Nilai valid:

    true.
    AuthResourceMode

    integer

    No

    Mode Sumber Daya Otorisasi. Nilai valid:

    1
    AuthResourceConfig

    string

    No

    Konfigurasi YAML untuk mode kompleks.

    ''
    AuthResourceList

    array<object>

    No

    Daftar aturan otorisasi untuk otentikasi. Beberapa kondisi aturan memiliki hubungan OR. Beberapa item pencocokan dalam satu kondisi aturan memiliki hubungan AND.

    array<object>

    No

    Daftar aturan otorisasi untuk otentikasi. Beberapa kondisi aturan memiliki hubungan OR. Beberapa item pencocokan dalam satu kondisi aturan memiliki hubungan AND.

    Id

    integer

    No

    ID catatan Sumber Daya.

    1
    DomainId

    integer

    No

    ID Nama Domain dalam aturan.

    1765
    Path

    string

    No

    Jalur pencocokan aturan.

    /test.
    MatchType

    string

    No

    Tipe pencocokan untuk jalur permintaan. Nilai valid:

    EQUAL.
    IgnoreCase

    boolean

    No

    Apakah sensitivitas huruf besar/kecil diaktifkan untuk jalur. Parameter ini digunakan saat membuat otentikasi kustom. Tipe otentikasi lain mengaktifkan sensitivitas huruf besar/kecil secara default. Nilai valid:

    AuthResourceHeaderList

    array<object>

    No

    Header permintaan aturan. Saat ini hanya digunakan untuk otentikasi kustom.

    object

    No

    Header permintaan aturan. Saat ini hanya digunakan untuk otentikasi kustom.

    HeaderKey

    string

    No

    Nama header permintaan.

    x-req.
    HeaderMethod

    string

    No

    Kondisi pencocokan. Nilai valid:

    EQUAL.
    HeaderValue

    string

    No

    Nilai header permintaan.

    123
    DeleteResourceIdList

    array

    No

    Daftar ID catatan Sumber daya yang akan dihapus.

    integer

    No

    ID catatan Sumber daya yang akan dihapus.

    2

    No

    Bahasa tanggapan. Nilai valid: zh (default): Bahasa Tionghoa. en: Bahasa Inggris.

    zh

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons.

    RequestId

    string

    ID permintaan.

    316F5F64-F73D-42DC-8632-01E308B6****
    HttpStatusCode

    integer

    Kode status HTTP.

    200
    Message

    string

    Paket yang dikembalikan.

    OK
    Code

    integer

    Kode tanggapan. Nilainya disinkronkan dengan parameter success.

    200
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai valid:

    true.
    Data

    integer

    ID aturan otentikasi.

    719

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 719
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    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.