Referensi API DescribeNamespaces: Parameter, Respons & Izin - SAE - Alibaba Cloud - Serverless App Engine

Mengkueri daftar namespace.

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

get

*全部资源

*

None

Sintaks permintaan

GET /pop/v1/paas/namespaces HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	Nomor halaman saat ini.	1
PageSize	integer	Yes	Jumlah entri per halaman. Nilai valid: 0 hingga 10000.	10

Elemen respons

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned by the system. Returns success if the request is successful. Returns a specific error message if the request fails.	success
TraceId	string	The trace ID that can be used to query the details of a call.	0a981dd515966966104121683d****
Data	object	The details of the namespaces.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of namespaces.	100
PageSize	integer	The number of entries returned on each page.	10
Namespaces	array<object>	The list of namespaces.
	object	The details of a namespace.
NamespaceDescription	string	The description of the namespace.	desc
AccessKey	string	The ACM-specific AccessKey ID. It can be used to manage data in an Application Configuration Management (ACM) namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.	b34dbe3315c64f9f99b58ea447ec****
SecretKey	string	The ACM-specific AccessKey secret. It can be used to manage data in an ACM namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.	G/w6sseK7+nb3S6HBmANDBMD****
NamespaceId	string	The ID of the namespace. You cannot query, modify, or delete the default namespace.	cn-beijing:test
AddressServerHost	string	The endpoint of the host.	addr-bj-internal.edas.aliyun.com
NamespaceName	string	The name of the namespace.	name
TenantId	string	The tenant ID.	838cad95-973f-48fe-830b-2a8546d7****
RegionId	string	The region ID.	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server-side error occurred.	200
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 100,
    "PageSize": 10,
    "Namespaces": [
      {
        "NamespaceDescription": "desc",
        "AccessKey": "b34dbe3315c64f9f99b58ea447ec****",
        "SecretKey": "G/w6sseK7+nb3S6HBmANDBMD****",
        "NamespaceId": "cn-beijing:test",
        "AddressServerHost": "addr-bj-internal.edas.aliyun.com",
        "NamespaceName": "name",
        "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
        "RegionId": "cn-beijing",
        "NameSpaceShortId": "test"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.