All Products
Search
Document Center

Serverless App Engine:DescribeApplicationNlbs

Last Updated:Jun 11, 2026

Melihat konfigurasi NLB aplikasi.

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

get

*全部资源

*

None None

Sintaks permintaan

GET /pop/v1/sam/app/nlb HTTP/1.1

Parameter permintaan

Parameter

Type

Required

Description

Example

AppId

string

No

ID aplikasi.

7171a6ca-d1cd-4928-8642-7d5cfe69****

Elemen respons

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID.

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

Message

string

The returned message. A value of success indicates a successful request; otherwise, an error code is returned.

success

TraceId

string

The trace ID used to query the details of the request.

ac1a0b2215622246421415014e****

ErrorCode

string

The error code.

  • This parameter is returned only if the request fails.

  • For more information, see the Error codes section of this topic.

Code

string

The HTTP status code. Valid values:

  • 2xx: The request is successful.

  • 3xx: The request is redirected.

  • 4xx: A client error occurred.

  • 5xx: A server error occurred.

200

Success

string

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Data

object

The data returned in the response.

Instances

object

A collection of instance details.

object

The details of an instance.

DnsName

string

The domain name.

nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com

Listeners

object

The listeners.

object

The information about listeners.

Protocol

string

The listener protocol.

TCPSSL

Port

integer

The listener port of the NLB instance.

80

Status

string

The status of the NLB listener.

  • Creating: The listener is being created.

  • Configuring: The listener is being configured.

  • Bounded: The listener runs as expected.

  • Unbinding: The listener is being deleted.

  • Failed: The listener is unavailable.

Bounded

TargetPort

integer

The open ports of the NLB instance.

8080

CertIds

string

The server certificates.

123157******

CreatedBySae

boolean

Indicates whether the instance is created by SAE.

  • true: The instance is created by SAE.

  • false: The existing instance is reused.

true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "",
  "Code": "200",
  "Success": "true",
  "Data": {
    "Instances": {
      "key": {
        "DnsName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
        "Listeners": {
          "key": {
            "Protocol": "TCPSSL",
            "Port": 80,
            "Status": "Bounded",
            "TargetPort": 8080,
            "CertIds": "123157******"
          }
        },
        "CreatedBySae": true
      }
    }
  }
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 InvalidApplication.NotFound The current application does not exist.
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.