All Products
Search

This Product

    Serverless App Engine:DescribeIngress

    Document Center

    Serverless App Engine:DescribeIngress

    Last Updated:Jun 11, 2026

    Menanyakan detail dari sebuah Ingress.

    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

    sae:DescribeIngress

    get

    *全部资源

    *

    		 None None

    Sintaks permintaan

    GET /pop/v1/sam/ingress/Ingress HTTP/1.1

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    IngressId

    integer

    Yes

    ID aturan perutean (routing). Panggil operasi ListIngresses untuk mendapatkan ID ini.

    16263

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    RequestId

    string

    ID permintaan.

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    Pesan yang dikembalikan.

    • Jika permintaan berhasil, success akan dikembalikan.

    • Jika permintaan gagal, kode kesalahan tertentu akan dikembalikan.

    success
    TraceId

    string

    ID pelacakan (trace) yang digunakan untuk menanyakan detail sebuah panggilan.

    0a981dd515966966104121683d****
    Data

    object

    Data yang dikembalikan.

    SlbId

    string

    ID instans Server Load Balancer (SLB).

    lb-uf62****6d13tq2u5
    NamespaceId

    string

    ID namespace.

    cn-beijing:sae-test
    Description

    string

    Deskripsi Ingress.

    ingress-sae-test
    ListenerPort

    integer

    Port listener instans SLB.

    443
    SlbType

    string

    Tipe instans SLB. Nilai yang valid:

    • internet: Instans yang menghadap internet.

    • intranet: Instans yang menghadap jaringan internal.

    internet
    CertId

    string

    ID sertifikat Classic Load Balancer (CLB).

    13623****809_16cad216b32_845_-419427029
    Name

    string

    Nama Ingress.

    lb-uf6jt0nu4z6ior943****-80-f5****
    DefaultRule

    object

    Aturan default.

    ContainerPort

    integer

    The backend port that is used by the default rule.

    8080
    AppName

    string

    The name of the application that is used by the default rule.

    app1
    AppId

    string

    The ID of the application that is used by the default rule.

    395b60e4-0550-458d-9c54-a265d036****
    BackendProtocol

    string

    The backend protocol. Valid values:

    • http: This protocol is suitable for applications that need to identify data content.

    • https: This protocol is suitable for applications that require encrypted data transmission.

    • grpc: This protocol is suitable for load balancing gRPC services in multiple languages, such as .NET.

    This parameter is returned only when LoadBalanceType is set to ALB and ListenerProtocol is set to HTTPS.

    http
    Rules

    array<object>

    Aturan-aturan penerusan.

    array<object>

    Sebuah aturan penerusan.

    AppName

    string

    The name of the destination application.

    app1
    ContainerPort

    integer

    The backend port of the application.

    8080
    Domain

    string

    The domain name of the application.

    edas.site
    AppId

    string

    The ID of the destination application.

    395b60e4-0550-458d-9c54-a265d036****
    Path

    string

    The URL path.

    /path1
    BackendProtocol

    string

    The backend protocol. Valid values:

    • http: This protocol is suitable for applications that need to identify data content.

    • https: This protocol is suitable for applications that require encrypted data transmission.

    • grpc: This protocol is suitable for load balancing gRPC services in multiple languages, such as .NET.

    This parameter is returned only when LoadBalanceType is set to ALB and ListenerProtocol is set to HTTPS.

    http
    RewritePath

    string

    The rewritten path.

    /${1}
    RuleActions

    array<object>

    The list of forwarding rule actions.

    object

    The list of rule actions.

    ActionType

    string

    The type of the forwarding action.

    • rewrite: a rewrite policy

    • redirect: a redirection policy

    rewrite
    ActionConfig

    string

    The specific configuration of the forwarding action.

    {\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
    Id

    integer

    ID Ingress.

    87
    LoadBalanceType

    string

    Tipe instans Server Load Balancer (SLB). Nilai yang valid:

    • clb: Classic Load Balancer (CLB), sebelumnya dikenal sebagai SLB.

    • alb: Application Load Balancer (ALB).

    clb
    ListenerProtocol

    string

    Protokol penerusan permintaan. Nilai yang valid:

    • HTTP: Cocok untuk aplikasi yang perlu mengidentifikasi konten data.

    • HTTPS: Cocok untuk aplikasi yang memerlukan transmisi terenkripsi.

    Parameter ini bersifat opsional untuk operasi CreateIngress dan UpdateIngress. Parameter ini tidak dikembalikan jika tidak ditentukan saat Ingress dibuat atau diperbarui.

    HTTP
    CertIds

    string

    ID sertifikat Application Load Balancer (ALB) yang dipisahkan dengan koma.

    87***35-cn-hangzhou,812***3-cn-hangzhou
    SecurityPolicyId

    string

    ID instans kebijakan keamanan.

    sp-n0kn923****
    RequestTimeout

    integer

    Batas waktu permintaan, dalam detik.

    Nilai yang valid: 1 hingga 180.

    Nilai default: 60.

    Jika server backend tidak merespons dalam periode batas waktu yang ditentukan, load balancer akan menghentikan permintaan dan mengembalikan kesalahan HTTP 504 kepada klien.

    60
    IdleTimeout

    integer

    Batas waktu idle koneksi, dalam detik.

    Nilai yang valid: 1 hingga 60.

    Nilai default: 15.

    Jika tidak ada permintaan yang diterima dalam periode batas waktu, load balancer akan menutup koneksi. Koneksi baru akan dibuat ketika permintaan berikutnya diterima.

    3
    EnableXForwardedFor

    boolean

    Menentukan apakah akan menggunakan header X-Forwarded-For untuk mengambil alamat IP klien.

    true
    EnableXForwardedForClientSrcPort

    boolean

    Menentukan apakah akan menggunakan header untuk mengambil port sumber klien.

    true
    EnableXForwardedForProto

    boolean

    Menentukan apakah akan menggunakan header X-Forwarded-Proto untuk mengambil protokol listener instans SLB.

    true
    EnableXForwardedForSlbId

    boolean

    Menentukan apakah akan menggunakan header SLB-ID untuk mengambil ID instans SLB.

    true
    EnableXForwardedForSlbPort

    boolean

    Menentukan apakah akan menggunakan header X-Forwarded-Port untuk mengambil port listener instans SLB.

    true
    CreatedBySae

    boolean

    Menunjukkan apakah instans Application Load Balancer (ALB) disediakan oleh SAE.

    true
    CorsConfig

    object

    Konfigurasi untuk Cross-Origin Resource Sharing (CORS). Metode HTTP yang valid:

    • GET

    • POST

    • PUT

    • DELETE

    • HEAD

    • OPTIONS

    • PATCH

    Enable

    string

    Specifies whether cross-domain support is enabled.

    false
    ExposeHeaders

    string

    The list of headers to expose.

    test_123
    AllowHeaders

    string

    The list of headers that are allowed for cross-domain requests.

    test_123
    AllowMethods

    string

    The HTTP methods that are allowed for cross-domain access.

    GET
    AllowOrigin

    string

    The list of allowed origins. You can specify only one element *, or one or more values.

    • A value must start with http:// or https:// and be followed by a valid domain name or a first-level wildcard domain name. Example: http://*.test.abc.example.com.

    • You can specify a port or not. The port number must be within the range of 1 to 65535.

    *
    AllowCredentials

    string

    Indicates whether credentials can be carried. Valid values:

    • on: yes.

    • off: no.

    on
    MaxAge

    string

    The maximum cache duration of preflight requests in the browser. Unit: seconds.

    Valid values: -1 to 172800.

    1000
    EnableGzip

    boolean

    Menentukan apakah akan mengaktifkan kompresi Gzip.

    ErrorCode

    string

    Kode kesalahan.

    • Parameter ini hanya dikembalikan jika permintaan gagal.

    • Untuk informasi selengkapnya, lihat bagian Error codes pada topik ini.

    Code

    string

    Kode status HTTP yang dikembalikan untuk permintaan. Nilai yang valid:

    • 2xx: Permintaan berhasil.

    • 3xx: Permintaan dialihkan.

    • 4xx: Terjadi kesalahan klien.

    • 5xx: Terjadi kesalahan server.

    200
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai yang valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "SlbId": "lb-uf62****6d13tq2u5",
    "NamespaceId": "cn-beijing:sae-test",
    "Description": "ingress-sae-test",
    "ListenerPort": 443,
    "SlbType": "internet",
    "CertId": "13623****809_16cad216b32_845_-419427029",
    "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule": {
      "ContainerPort": 8080,
      "AppName": "app1",
      "AppId": "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol": "http"
    },
    "Rules": [
      {
        "AppName": "app1",
        "ContainerPort": 8080,
        "Domain": "edas.site",
        "AppId": "395b60e4-0550-458d-9c54-a265d036****",
        "Path": "/path1",
        "BackendProtocol": "http",
        "RewritePath": "/${1}",
        "RuleActions": [
          {
            "ActionType": "rewrite",
            "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
          }
        ]
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
    "SecurityPolicyId": "sp-n0kn923****",
    "RequestTimeout": 60,
    "IdleTimeout": 3,
    "EnableXForwardedFor": true,
    "EnableXForwardedForClientSrcPort": true,
    "EnableXForwardedForProto": true,
    "EnableXForwardedForSlbId": true,
    "EnableXForwardedForSlbPort": true,
    "CreatedBySae": true,
    "CorsConfig": {
      "Enable": "false",
      "ExposeHeaders": "test_123",
      "AllowHeaders": "test_123",
      "AllowMethods": "GET",
      "AllowOrigin": "*",
      "AllowCredentials": "on",
      "MaxAge": "1000"
    },
    "EnableGzip": false
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.NotEmpty You must specify the parameter %s.
    400 InvalidParameter.Obviously The specified parameter is invalid {%s}.
    400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.