DescribeApplications API Reference for PolarDB - PolarDB - Alibaba Cloud - PolarDB

Mendapatkan daftar aplikasi untuk semua Instans PolarDB Basis Data Relasional Cloud-Native di Wilayah tertentu.

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

polardb:DescribeApplications

get

*全部资源

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID Wilayah.	cn-beijing
ApplicationIds	string	No	Daftar ID aplikasi. Jika ditentukan, operasi ini hanya mengembalikan informasi tentang aplikasi yang ditentukan.	pa-**************
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 30 50 100 Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai default: 1.	1
DBClusterId	string	No	ID Instans PolarDB Basis Data Relasional Cloud-Native. Jika ditentukan, operasi ini hanya mengembalikan informasi tentang aplikasi yang terkait dengan Instans ini.	pc-**************
ApplicationTypes	string	No
Tag	array<object>	No
	object	No
Key	string	No		testKey
Value	string	No		testValue

Elemen respons

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
TotalRecordCount	integer	The total record count.	1
PageRecordCount	integer	The number of records on the current page.	1
PageNumber	integer	The page number.	1
Items	object	Contains the returned applications.
Applications	array<object>	A list of applications.
	array<object>	Details of an application.
Status	string	The status of the application. Valid values: Creating: The application is being created. Activated: The application is running. Maintaining: The application is under maintenance. ClassChanging: The application configuration is being changed. Transing: The application is being migrated. MinorVersionUpgrading: The minor version is being upgraded. NetCreating: The endpoint is being created. NetDeleting: The endpoint is being deleted. NetModifying: The endpoint is being modified. Restarting: The application is restarting. Locking: The application is being locked. Locked: The application is locked. Unlocking: The application is being unlocked. Deleting: The application is being deleted.	Activated
Description	string	The description or remarks of the application.	myapp
EngineVersion	string	The database engine version.	1.0.0
ZoneId	string	The zone.	cn-hangzhou-b
Expired	string	Indicates whether the application has expired.	false
PayType	string	The billing method. This parameter is empty if the application is not billed.	Postpaid
PolarFSInstanceId	string	The ID of the PolarFileSystem (PolarFS) instance that is associated with the application.	pcs-**************
Endpoints	object
endpoint	array<object>	The list of application endpoints.
	object	The application endpoint.
IP	string	The IP address.	192.168.0.3
Port	string	The port.	8080
NetType	string	The type of the endpoint. Valid values: Private: VPC endpoint Public: public endpoint	Public
ApplicationType	string	The application type.	supabase
CreationTime	string	The creation time.	2025-03-25T09:37:10Z
RegionId	string	The region.	cn-hangzhou
ApplicationId	string	The application ID.	pa-**************
ExpireTime	string	The expiration time.	2025-06-25T09:37:10Z
DBClusterId	string		pc-xxxxxx
Tags	object
Tag	array<object>
	object
Key	string		testKey
Value	string		testValue

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "Applications": [
      {
        "Status": "Activated",
        "Description": "myapp",
        "EngineVersion": "1.0.0",
        "ZoneId": "cn-hangzhou-b",
        "Expired": "false",
        "PayType": "Postpaid",
        "PolarFSInstanceId": "pcs-**************\n",
        "Endpoints": {
          "endpoint": [
            {
              "IP": "192.168.0.3",
              "Port": "8080",
              "NetType": "Public"
            }
          ]
        },
        "ApplicationType": "supabase",
        "CreationTime": "2025-03-25T09:37:10Z",
        "RegionId": "cn-hangzhou",
        "ApplicationId": "pa-**************",
        "ExpireTime": "2025-06-25T09:37:10Z",
        "DBClusterId": "pc-xxxxxx",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.