All Products
Search

This Product

    Microservices Engine:AddGatewayAuthConsumer

    Document Center

    Microservices Engine:AddGatewayAuthConsumer

    Last Updated:Jun 10, 2026

    Menambahkan konsumen tempat gerbang melakukan operasi otentikasi.

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

    create

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    GatewayUniqueId

    string

    Yes

    ID unik gerbang.

    gw-c70622ff52fe49beb29bea9a6f52****
    Name

    string

    Yes

    Nama konsumen.

    name
    Type

    string

    Yes

    Tipe otentikasi. Nilai valid:

    • JWT.

    JWT
    EncodeType

    string

    No

    Tipe Enkripsi. Nilai valid:

    • RSA

    • OCT.

    RSA
    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"}]}
    TokenName

    string

    No

    Nama parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan di Header Authorization, seperti Authorization: Bearer <Content of a token>.

    Authorization
    TokenPass

    boolean

    No

    Apakah akan mengaktifkan pass-through.

    true
    TokenPosition

    string

    No

    Posisi parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan di Header Authorization, seperti Authorization: Bearer <Content of a token>.

    HEADER
    TokenPrefix

    string

    No

    Prefiks parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan di Header Authorization, seperti Authorization: Bearer <Content of a token>.

    Bearer

    KeyName

    string

    No

    Nama kunci yang digunakan untuk otentikasi identitas berbasis JWT.

    iss
    KeyValue

    string

    No

    Nilai kunci yang digunakan untuk otentikasi identitas berbasis JWT.

    abcd
    Description

    string

    No

    Deskripsi konsumen.

    description
    AcceptLanguage

    string

    No

    Bahasa tanggapan. Nilai valid:

    • zh: Bahasa Mandarin

    • en: Bahasa Inggris.

    zh

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RestResult<List>

    RequestId

    string

    The ID of the request.

    69AD2AA7-DB47-449B-941B-B14409DF****
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    True
    Code

    integer

    The status code. A value of 200 is returned if the request is successful.

    200
    ErrorCode

    string

    The error code that is returned.

    mse-100-000
    HttpStatusCode

    integer

    The HTTP status code returned.

    200
    Message

    string

    The error message returned.

    The request is successfully processed.

    DynamicCode

    string

    The dynamic part in the error message.

    code
    DynamicMessage

    string

    The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter.

    Catatan

    If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.

    The specified parameter is invalid.
    Data

    integer

    The ID of the consumer.

    2

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 2
}

    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.