All Products
Search

This Product

    Microservices Engine:AddGatewayRoute

    Document Center

    Microservices Engine:AddGatewayRoute

    Last Updated:Jun 10, 2026

    Menambahkan rute ke gateway.

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

    create

    *Gateway

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    GatewayId

    integer

    No

    ID gateway.

    526
    Name

    string

    Yes

    Nama rute.

    test
    RouteOrder

    integer

    No

    Nomor urut rute. Nilai yang lebih kecil menunjukkan prioritas yang lebih tinggi.

    1
    Predicates

    object

    No

    Aturan pencocokan.

    PathPredicates

    object

    No

    Tipe pencocokan rute.

    Path

    string

    No

    Path.

    /test
    Type

    string

    No

    Tipe pencocokan rute. Nilai yang valid:

    • PRE: pencocokan prefiks

    • EQUAL: pencocokan tepat

    • ERGULAR: pencocokan ekspresi reguler

    PRE
    IgnoreCase

    boolean

    No

    Menentukan apakah akan mengabaikan sensitivitas huruf besar/kecil.

    true
    MethodPredicates

    array

    No

    Informasi tentang pencocokan metode.

    string

    No

    Metode.

    GET
    HeaderPredicates

    array<object>

    No

    Informasi tentang pencocokan header.

    object

    No

    Header permintaan.

    Key

    string

    No

    Kunci header permintaan.

    debug
    Value

    string

    No

    Nilai yang sesuai.

    test
    Type

    string

    No

    Tipe pencocokan.

    PRE
    QueryPredicates

    array<object>

    No

    Pencocokan parameter URL.

    object

    No

    Parameter URL.

    Key

    string

    No

    Nama parameter.

    userid
    Value

    string

    No

    Nilai dari kondisi pencocokan.

    test
    Type

    string

    No

    Tipe pencocokan.

    PRE
    Services

    array<object>

    No

    Layanan yang akan dikaitkan dengan gateway. Parameter ini diperlukan jika parameter Route Point disetel ke Single Service, Multiple Services, atau Label routing.

    array<object>

    No

    Daftar layanan.

    ServiceId

    integer

    No

    ID layanan.

    353
    Percent

    integer

    No

    Bobot lalu lintas dari layanan versi tertentu, dalam persentase. Parameter ini diperlukan jika parameter Route Point disetel ke Multiple Services atau Label routing.

    80
    Version

    string

    No

    Versi layanan. Parameter ini hanya diperlukan jika parameter Route Point disetel ke Label routing.

    v1
    Name

    string

    No

    Nama.

    user
    SourceType

    string

    No

    Tipe sumber.

    MSE
    Namespace

    string

    No

    Namespace tempat layanan berada.

    default
    GroupName

    string

    No

    Nama grup layanan.

    test
    AgreementType

    string

    No

    Tipe Protokol.

    DUBBO
    HttpDubboTranscoder

    object

    No

    Konverter protokol Dubbo.

    DubboServiceName

    string

    No

    Nama layanan Dubbo.

    org.apache.dubbo.samples.basic.api.DemoService
    DubboServiceVersion

    string

    No

    Versi layanan Dubbo.

    0.0.0
    DubboServiceGroup

    string

    No

    Grup layanan.

    group
    MothedMapList

    array<object>

    No

    Aturan penerusan Dubbo.

    array<object>

    No

    Pemetaan metode.

    DubboMothedName

    string

    No

    The Dubbo method name.

    sayHello
    HttpMothed

    string

    No

    The HTTP method.

    Catatan

    Supported HTTP method parameter values:

    • ALL_GET.

    • ALL_POST.

    • ALL_PUT.

    • ALL_DELETE.

    • ALL_PATCH.

    ALL_GET
    Mothedpath

    string

    No

    The path that is used to match a method.

    /mytestzbk/sayhello
    PassThroughAllHeaders

    string

    No

    The pass-through type of the header.

    Catatan

    Enumeration values for pass-through types:

    • PASS_ALL: All headers are passed through.

    • PASS_NOT: All headers are not passed through.

    • PASS_ASSIGN: Specified headers are passed through.

    PASS_NOT
    PassThroughList

    array

    No

    The headers that are passed through.

    string

    No

    The header value that is passed through.

    x-forward
    ParamMapsList

    array<object>

    No

    The information about parameter mappings.

    object

    No

    The parameter mapping object.

    ExtractKeySpec

    string

    No

    The input parameter position.

    Catatan

    Enumeration values for input parameter positions:

    • Request parameter: ALL_QUERY_PARAMETER

    • Request header: ALL_HEADER

    • URI of the request: ALL_PATH

    • Request body: ALL_BODY

    ALL_QUERY_PARAMETER
    ExtractKey

    string

    No

    The key of the input parameter that is extracted.

    name
    MappingType

    string

    No

    The type of the backend service parameter.

    java.lang.String
    ServicePort

    integer

    No

    Nomor port layanan.

    443
    DomainId

    integer

    No

    ID domain.

    20
    DestinationType

    string

    No

    Tipe layanan tujuan. Nilai yang valid:

    • Single: layanan tunggal.

    • Multiple: beberapa layanan.

    • VersionOriented: label routing.

    • Mock: mock.

    • Redirect: pengalihan.

    Valid values:

    • VersionOriented :

      VersionOriented

    • Multiple :

      Multiple

    • Single :

      Single

    • Redirect :

      Redirect

    • Mock :

      Mock

    Multiple
    DirectResponseJSON

    object

    No

    Konfigurasi respons mock.

    Code

    integer

    No

    Kode pengembalian Mock.

    403
    Body

    string

    No

    Nilai pengembalian.

    hello
    GatewayUniqueId

    string

    Yes

    ID unik gateway.

    gw-492af9b04bb4474cae9d645be8*****
    DomainIdListJSON

    string

    Yes

    ID dari domain.

    [0,94]
    RedirectJSON

    object

    No

    Konfigurasi aksi pengalihan.

    Code

    integer

    No

    Kode status HTTP.

    302
    Host

    string

    No

    Hostname yang akan dialihkan.

    test.com
    Path

    string

    No

    Path yang akan dialihkan.

    /test
    EnableWaf deprecated

    boolean

    No

    Tidak digunakan lagi. Gunakan UpdateGatewayRouteWafStatus untuk memperbarui status WAF dari sebuah rute.

    true
    Fallback

    boolean

    No

    Menentukan apakah akan mengaktifkan layanan fallback.

    true
    FallbackServices

    array<object>

    No

    Layanan fallback.

    object

    No

    ServiceId

    integer

    No

    ID layanan.

    353
    Percent

    integer

    No

    Bobot dalam bentuk nilai persentase.

    80
    Version

    string

    No

    Versi layanan.

    v1
    Name

    string

    No

    Nama.

    user
    SourceType

    string

    No

    Tipe sumber.

    MSE
    Namespace

    string

    No

    Namespace tempat layanan berada.

    default
    GroupName

    string

    No

    Nama grup tempat layanan berada.

    test
    AgreementType

    string

    No

    Tipe Protokol.

    DUBBO
    ServicePort

    integer

    No

    Nomor port layanan.

    443
    RouteType

    string

    No

    Tipe rute. Nilai yang valid:

    Op: rute manajemen.

    Op
    Policies

    string

    No

    Kebijakan routing sebagai string JSON.

    {"CORS":"{\"allowMethods\":\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\",\"allowHeaders\":\"*\",\"exposeHeaders\":\"*\",\"unitNum\":12,\"allowCredentials\":true,\"status\":\"off\",\"allowOrigins\":\"*\",\"timeUnit\":\"h\"}","Timeout":"{\"unitNum\":10,\"timeUnit\":\"s\",\"status\":\"off\"}","Retry":"{\"attempts\":2,\"retryOn\":[\"5xx\"],\"status\":\"off\"}","HTTPRewrite":"{\"pathType\":\"EQUAL\",\"path\":\"/o\",\"status\":\"off\"}","Waf":"{\"enabled\":false}","HeaderOp":"{\"status\":\"off\",\"headerOpItems\":[{\"directionType\":\"Request\",\"opType\":\"Add\",\"key\":\"kkk\",\"value\":\"ll\"}]}"}
    Description

    string

    No

    Deskripsi rute.

    a route for xxx
    AcceptLanguage

    string

    No

    Bahasa dari respons. Nilai yang valid:

    • zh: Mandarin.

    • en: Inggris.

    zh

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Struktur data.

    RequestId

    string

    ID permintaan.

    03A3E2F4-6804-5663-9D5D-2EC47A1*****
    HttpStatusCode

    integer

    Kode status HTTP.

    200
    Message

    string

    Pesan respons.

    请求处理成功
    Code

    integer

    Kode yang dikembalikan.

    200
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai yang valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true
    Data

    integer

    ID rute.

    555
    ErrorCode

    string

    Kode kesalahan.

    • InvalidParameter: Parameter tidak valid. Contohnya, parameter tidak lengkap atau format parameter tidak valid.

    • IllegalRequest: Permintaan tidak valid. Akses tidak sah ke data yang diinisiasi oleh parameter teridentifikasi.

    • NoPermission: Anda tidak memiliki izin untuk melakukan operasi ini.

    • NotFound: Resource tidak ada.

    • InternalError: Terjadi kesalahan internal.

    InvalidParameter

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": 555,
  "ErrorCode": "InvalidParameter"
}

    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.